Enhance GitHub PR comment experience (#26)

* Add support for PR labels and linking to full report

* Add support for rule name, collapsible fields

* Add helper functions for GitHub PR comments

* Pass config for repository metadata and feature flags

* Expand notification configuration params

* Augment existing GHA docs to explain configuration options

* Add unit tests for new GH helper functionality

* Update GHA manifest to include new params

* Update git ignore to handle new docs

* Update README with new PR comment functionality

* Update helper tests import

* Update all connectors to have PR comment feature parity

* Centralize all GitHub PR helper logic

* Update README with new enhancements

* Fix clickable links and auto-collapse logic

* Prune GHA workspace path prefixes

* Update connector formatting

Signed-off-by: lelia <lelia@socket.dev>

* Colorize GitHub PR label options

Signed-off-by: lelia <lelia@socket.dev>

* Better filepath formatting, CVE links, CVSS scores

Signed-off-by: lelia <lelia@socket.dev>

* Update helper tests to cover new functionality

Signed-off-by: lelia <lelia@socket.dev>

* Wrap standard connector logic

Signed-off-by: lelia <lelia@socket.dev>

* Wrap connector logic, add support for 32px logo

* Add 32x32px Socket logo asset

Signed-off-by: lelia <lelia@socket.dev>

* Overhaul git ignore with better structure and categories

Signed-off-by: lelia <lelia@socket.dev>

* Update README to reflect new GHA functionality, dedupe usage examples

Signed-off-by: lelia <lelia@socket.dev>

* Add README to cover unit/integration testing with pytest

Signed-off-by: lelia <lelia@socket.dev>

* Clean up and deduplicate GHA docs

Signed-off-by: lelia <lelia@socket.dev>

* Update CI/CD install refs to defer to GHA docs

Signed-off-by: lelia <lelia@socket.dev>

* Add docs to cover new GitHub PR comment functionality and config

Signed-off-by: lelia <lelia@socket.dev>

* Apply filepath cleaning logic to text formatting

Signed-off-by: lelia <lelia@socket.dev>

* Fix formatting logic to enable jumping to specific LoC

Signed-off-by: lelia <lelia@socket.dev>

* Whitespace change to test commit signing

Signed-off-by: lelia <lelia@socket.dev>

* Second whitespace commit for signing test

Signed-off-by: lelia <lelia@socket.dev>

* Testing new signing key with verified email

Signed-off-by: lelia <lelia@socket.dev>

* Update PR logic to handle GH markdown rendering of HTML

Signed-off-by: lelia <lelia@socket.dev>

* Add dev script to preview PR comment formatting behavior

Signed-off-by: lelia <lelia@socket.dev>

* Add unittests for PR formatting

Signed-off-by: lelia <lelia@socket.dev>

* Update ignore file to include new dev scripts

Signed-off-by: lelia <lelia@socket.dev>

* Prepare for minor version release to 1.1.0

Signed-off-by: lelia <lelia@socket.dev>

* Use stable favicon logo asset URL

Signed-off-by: lelia <lelia@socket.dev>

* Document required perms for PR labels

Signed-off-by: lelia <lelia@socket.dev>

* Remove unused github helper

Signed-off-by: lelia <lelia@socket.dev>

---------

Signed-off-by: lelia <lelia@socket.dev>

Author: lelia

.gitignore

@@ -1,114 +1,105 @@
-
-.idea
-venv
-.venv
-build
-dist
-*.build
-*.dist
-*.egg-info
-test
-*.env
-run_container.sh
-*.zip
-bin
-# Note: Ignore any local dev scripts, but include ones used by the project
-scripts/*.py
-!scripts/enrich_rules.py
-!scripts/rewrite_messages.py
-!scripts/update_cwe_catalog.py
-!scripts/verify_jira_dashboard_config.py
-*.json
-markdown_overview_temp.md
-markdown_security_temp.md
+# OS files
 .DS_Store
-*.pyc
-test.py
 
-# Note: requirements.txt is no longer needed - using pyproject.toml + uv.lock instead
-# Version files are auto-managed by .hooks/version-check.py
-*.cpython-312.pyc
-file_generator.py
-.env
-*.md
-!README.md
-!docs/*.md
-!tests/README.md
-test_results
-local_tests/
-custom_rules/
+# IDEs and editors
+.idea/
+.vscode/
+*.sublime-workspace
+*.sublime-project
+*.swp
+*~
 
-# Common Python ignores
+# Python
 __pycache__/
 *.py[cod]
 *$py.class
+.python-version
+
+# Virtual environments
+venv/
+.venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# Build and distribution
+build/
+dist/
+*.build
+*.dist
+*.egg-info
+.eggs/
+*.egg
+
+# Testing and coverage
 .pytest_cache/
 .mypy_cache/
 .coverage
 .coverage.*
 htmlcov/
+coverage/
+coverage.xml
+nosetests.xml
+test-results/
+test_results/
+
+# pip
 pip-wheel-metadata/
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Virtual environments
-env/
-ENV/
-env.bak/
-venv.bak/
-
-# IDEs and editors
-.vscode/
-.idea/
-*.sublime-workspace
-*.sublime-project
-*.swp
-*~
-
 # Node
 node_modules/
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 .pnp/
 
-# Build and distribution
-.eggs/
-*.egg
-dist/
-build/
-
-# Coverage and test output
-coverage/
-coverage.xml
-nosetests.xml
-test-results/
+# Jupyter
+.ipynb_checkpoints/
 
 # Logs and runtime files
-logs/
-
+*.log
 *.pid
 *.sock
+logs/
 
-# OS files
-.DS_Store
+# Temporary files
+*.tmp
+*.temp
+*.zip
 
 # Binary and compiled
 *.exe
 *.dll
 *.so
 *.dylib
 
-# Jupyter
-.ipynb_checkpoints/
-
-# Local temporary files
-*.tmp
-*.temp
-# Ignore output logs and generated src files
-*.log
+# Environment and secrets
+*.env
 
-.python-version
+# Data files (generated)
+*.json
 .socket.fact.json
 
+# Markdown: ignore all except documentation
+*.md
+!README.md
+!docs/*.md
+!tests/README.md
+
+# Project-specific (local scripts and test files)
+test/
+test.py
+run_container.sh
+bin/
+scripts/*.py
+!scripts/enrich_rules.py
+!scripts/rewrite_messages.py
+!scripts/update_cwe_catalog.py
+!scripts/verify_jira_dashboard_config.py
+!scripts/preview_pr_comments.py
+file_generator.py
+local_tests/
 custom_rules/