If you discover a security vulnerability in PR Sentinel, please do not open a public GitHub issue. Instead, please report it responsibly by:
- Email: Send a detailed report to the repository maintainer
- Include:
- Description of the vulnerability
- Steps to reproduce (if applicable)
- Potential impact
- Suggested fix (if you have one)
- Never commit API keys, tokens, or credentials to version control
- Use GitHub Secrets for storing
ANTHROPIC_API_KEY,OPENAI_API_KEY, and AWS credentials - Configure your
.envfile in.gitignoreto prevent accidental commits
- PR Sentinel analyzes pull request diffs, which may contain sensitive data
- Review your diffs before PR Sentinel processes them
- For private data handling, consider self-hosting with local models (Ollama)
- Anthropic (Claude): Uses HTTPS and encrypted transmission. See Anthropic Security
- OpenAI (GPT-4): Uses HTTPS and encrypted transmission. See OpenAI Security
- AWS Bedrock: Inherits AWS security guarantees. See AWS Bedrock Security
- Ollama (Local): No data leaves your machine. Requires self-hosting
- PR Sentinel uses well-maintained dependencies: Octokit, @actions/core, TypeScript
- Monitor GitHub's dependency alerts for security updates
- Run
npm auditregularly to check for vulnerabilities in dependencies
- The action integrates with GitHub Actions; ensure your workflow permissions are minimal
- Use
contents: readandsecurity-events: writeonly (as shown in docs) - Restrict secrets to specific branch protection rules
- Report: Send security report to maintainer
- Acknowledgment: You'll receive confirmation within 24-48 hours
- Investigation: We'll investigate and develop a fix
- Disclosure: Once fixed, we'll publish a security advisory and release an updated version
- Public Notice: Security fix will be announced in release notes
-
Keep PR Sentinel Updated:
uses: nshportun/prSentinel@v0.1.0 # Pin to specific version
-
Use Read-Only Tokens When Possible:
permissions: contents: read # Read-only access security-events: write # Write to security tab only
-
Monitor Your Dependencies:
- Enable GitHub Dependabot alerts
- Review dependency updates before merging
-
Review Generated Reports:
- Check SARIF reports in GitHub Security tab
- Verify false positives in your CI logs
- Take action on detected issues
- Schema Detection: LLM-based schema analysis may have false negatives on novel data formats
- PII Patterns: AI-powered PII detection depends on model accuracy; edge cases may be missed
- Regex Patterns: Secret detection uses regex patterns which can generate false positives
For maximum security:
-
Use Local Models:
model-provider: ollama
This keeps all data local and doesn't transmit diffs to external APIs.
-
Air-Gapped Deployment: Run the action in an air-gapped environment with local model inference.
-
Audit Logs: Monitor GitHub Actions logs for unusual activity or configuration changes.
If you have security questions or concerns (non-vulnerability), feel free to:
- Open a discussion: https://github.com/nshportun/prSentinel/discussions
- Check documentation: https://github.com/nshportun/prSentinel#readme
Last Updated: 2026-07-23