theupdateframework / theupdateframework/python-tuf
cd: re-enable release signing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 304
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 17
Description
Description of issue or feature request:
https://github.com/theupdateframework/python-tuf/pull/1946 adds a CD workflow to release build artifacts on PyPI and GH upon successful completion of the CI workflow for a pushed release tag.
The PR also removes instructions from RELEASE.md to gpg sign release artifacts and add them to the GitHub release assets as part of the previously manual release process. However, the installation docs still mention release signatures.
Current behavior:
No instructions / release process integration to sign release artifacts
Expected behavior:
Add instructions to sign release artifacts and integrate with release process
Ideas:
- quick-fix 1: sign in GitHub CD action
- quick-fix 2: sign locally and upload signatures to release assets manually (bonus: integrate signing/uploading with
verify_releasescript) - long-term fix: e.g. in-toto (https://github.com/theupdateframework/python-tuf/issues/529)
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
Start with the CD workflow introduced by PR 1946 and the release instructions in RELEASE.md; compare them with the installation documentation's verify-release-signatures section. Review the verify_release script as a possible integration point, then determine which signing approach is approved. Done means release artifacts have signing instructions and signing is integrated into the release process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- documentation, release, security
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100