Repository navigation
Add security policy and document enabled CodeQL scanning - #28
Merged
Merged
Conversation
Add private vulnerability reporting guidance and repository security boundaries. Record the enabled Python and GitHub Actions CodeQL configuration and link the policy from the README without changing released pet packages.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scope
Add a root security policy and make private vulnerability reporting discoverable. GitHub-managed CodeQL default setup is now enabled for Python and GitHub Actions with security-extended queries, remote and local inputs, and weekly scanning.
Reason
The repository lacked a security policy and code scanning configuration. The policy explains reporting, trust boundaries, security properties, and validation limits without adding finding exclusions or response-time promises.
Files affected
SECURITY.md: private reporting, versions, scope, and security guidance.README.md: link to the policy.docs/MAINTENANCE.md: CodeQL configuration, verification, and reporting instructions.Runtime impact
Documentation and repository security configuration only; no runtime or artwork changes.
UI impact
GitHub can display the security policy. The pet catalogue and installers are unchanged.
Migration impact
None. No new release or pet version bump is needed; v1.0.1 remains unchanged.
Validation performed
657b234827be436f8b9e73d50967bbb7cbe738b2; both analyses uploaded with zero results and no warnings/errors.Rollback safety
The three documentation files can be reverted independently. CodeQL default setup is a GitHub setting, so reverting this PR alone does not disable it.