docs: add release process documentation#490
Conversation
tomasaschan
left a comment
There was a problem hiding this comment.
For the few releases I've shipped, I've used the UI instead of the GH CLI. That has the advantage that you can open the release notes in draft mode even before choosing a tag, and the tag gets published at the same time as the release. Since the PR list in the release notes is a good indicator for which release number (minor or patch) should be tagged, it's useful to have it available before picking a number.
The fact that the UI doesn't create the tag until the release is published is also useful to ensure we don't have tags without releases published, or need to move tags.
Reflects the maintainer's preferred workflow using the GitHub UI for drafting releases, which publishes the tag atomically with the release and shows the PR list before picking a version number. Closes spf13#434
49ed2e7 to
9ba8488
Compare
|
Thanks for the feedback! I've updated RELEASING.md to document the GitHub UI workflow as the recommended method first, with the GH CLI as an alternative. The UI approach is now listed as Method 1 since it has the advantages you mentioned (atomic tag+release, PR list before version pick). |
Summary
Closes #434
Adds a
RELEASING.mdthat documents the step-by-step release process for pflag maintainers. The current process relies on institutional knowledge that is easy to forget (as noted in #434).Content
--generate-notesvs manual release notes