Skip to content

Commit 41a449e

Browse files
committed
Private vulnerability reporting
1 parent 3eef53c commit 41a449e

4 files changed

Lines changed: 23 additions & 10 deletions

File tree

.github/workflows/publish.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,6 @@ jobs:
2323
steps:
2424
- name: "Checkout repository"
2525
uses: "actions/checkout@a12a3943b4bdde767164f792f33f40b04645d846"
26-
with:
27-
fetch-depth: 0
28-
29-
- name: "Require signed git tag"
30-
run: |
31-
# Work-around for actions/checkout#882 replacing all tags with lightweight tags.
32-
git fetch --tags --force origin
33-
git show ${{ github.ref_name }}
34-
git verify-tag ${{ github.ref_name }}
3526

3627
- name: "Setup Python"
3728
uses: "actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984"

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
### Added
88

99
- Added instructions for configuring signed commits and tags automatically from git.
10-
- Added requirement that the triggering git tag be signed in the `publish` GitHub workflow.
10+
- Added security policy and instructions for configuring private vulnerability reporting.
1111

1212
<a id='changelog-0.4.0'></a>
1313
## 0.4.0 (2022-12-09)

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,13 @@ If you don't have 2FA enabled on PyPI already there's a section in the [PyPI Hel
217217
- Select "Add secret" in the environment secrets section
218218
- Add the PyPI API token value under `PYPI_TOKEN`
219219

220+
### Private vulnerability reporting
221+
222+
- Settings > Code security and analysis
223+
- Select "Enable" for "Private vulnerability reporting". This will allow
224+
users to privately submit vulnerability reports directly to the repository.
225+
- Update the URL in the `SECURITY.md` file to the URL of your own repository.
226+
220227
## Verifying configurations
221228

222229
### Verifying reproducible builds

SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
This is where you'd put your project's security policy. Be sure to
4+
enable "Private vulnerability reporting" on GitHub within the "Code security and analysis"
5+
section of repository settings and update the below URL to your repository's (owner/name) slug.
6+
7+
## Supported Versions
8+
9+
Use this section to inform users about which versions of your project are
10+
currently being supported with security updates.
11+
12+
## Reporting a Vulnerability
13+
14+
Vulnerabilities can be disclosed privately by [creating a new security advisory](https://github.com/sethmlarson/secure-python-package-template/security/advisories).
15+
Maintainers will follow up with a fix and coordinate a release within the security advisory.

0 commit comments

Comments
 (0)