semantic-release / semantic-release/git
Update GPG documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 339
- Forks
- 75
- Avg merge
- 5h 15m
- Merged PRs (30d)
- 6
Description
As the GPG documentation on this plugin's README is getting a bit old, does not mention a good GitHub Actions solution, and is a bit confusing, it would benefit from being refreshed.
Worth mentioning that if we progress towards getting https://github.com/semantic-release/semantic-release/pull/1871 merged, it would be worth moving the GPG instructions directly into the web documentation (maybe even preemptively).
Things that could/should be included in the future documentation:
crazy-max/ghaction-import-gpgas discussed in #438.- to meet the "require verified commits" branch protection requirement, the documentation suggests adding the generated GPG key to the account owning the GitHub token used for release, which is hazardous, given a user with push access to the repository could then retrieve it and use it to impersonate you. That approach would be secure only if using a dedicated bot account (ideally per repository).
- the issue above would not apply to signing tags, because the branch protection rule does not apply to them
Contributor guide
No contributing guide indexed for this repository
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 GPG section of the plugin README and review the discussion in #438, then check the possible move to web documentation referenced by semantic-release/semantic-release#1871. Update the documentation with the GitHub Actions option, the warning about using a release account for verified commits, and the distinction between commit and tag signing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100