Skip to content

docs: add a security policy for the organization's repositories - #5

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/security-policy
Nov 2, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
chore/security-policy

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

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 of mkdocs-ng, mkdocs-sumi and mkdocs-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.

mkdocs keeps its own SECURITY.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 for mkdocs-sumi, mkdocs-material, catalog, best-of-generator and .github (Settings > Code security > Private vulnerability reporting).

Before / After

Security policy per repository (GraphQL securityPolicyUrl):

Repository Before After merge
mkdocs own SECURITY.md unchanged
mkdocs-sumi none this policy
mkdocs-material none this policy
catalog none this policy
best-of-generator none this policy
.github none this policy

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.
@shenxianpeng
shenxianpeng merged commit ea24f1c into main Nov 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant