mne-tools / mne-tools/mne-python
small security upgrade to our upload action
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
There is a subtle security hole in how GitHub handles release artifacts: they're auto-genned on each request (so if GH changes their process for generating the wheels sdists (ZIP files), the checksum can change, which makes it hard to verify the authenticity of our wheels sdists by downstream users). We could add to our release action a new step that attaches the built wheel sdist that we end up pushing to PyPI, in which case its checksum will be stable.
example of how to do this: https://github.com/conda/conda/blob/main/.github/worflows/upload.yml
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the repository's release action and compare its upload step with the example workflow at conda/conda's upload.yml. Confirm which sdist is pushed to PyPI, attach that same artifact to the release, and verify that its checksum remains stable across downloads.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100