Repository navigation
docs: add a security policy for the organization's repositories - #5
Merged
Merged
Conversation
GitHub uses this SECURITY.md for every mkdocs-ng repository without its own. Only mkdocs-ng/mkdocs had a policy; mkdocs-sumi, mkdocs-material, catalog and best-of-generator showed none.
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.
Adds
.github/SECURITY.md, which GitHub uses as the security policy for every mkdocs-ng repository that has none of its own. It covers supported versions (the latest release ofmkdocs-ng,mkdocs-sumiandmkdocs-ng-material, no backports), how to report (privately with "Report a vulnerability" on the affected repository's Security tab, not in a public issue) and what to expect (acknowledgement within a few days, a fix in a new release, an advisory crediting the reporter). The repository README lists the new file.mkdocskeeps its ownSECURITY.md.Private vulnerability reporting must be on for the "Report a vulnerability" button to appear. Today it is on only for
mkdocs; it is off formkdocs-sumi,mkdocs-material,catalog,best-of-generatorand.github(Settings > Code security > Private vulnerability reporting).Before / After
Security policy per repository (GraphQL
securityPolicyUrl):SECURITY.md