Skip to content

Commit 5fdac2d

Browse files
authored
Merge pull request #490 from happysnaker/docs-release-process
docs: add release process documentation
2 parents dca783a + 9ba8488 commit 5fdac2d

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Releasing pflag
2+
3+
This document describes how to create a new pflag release.
4+
5+
## Method 1: GitHub UI (recommended by maintainers)
6+
7+
1. Go to the [releases page](https://github.com/spf13/pflag/releases)
8+
2. Click **"Draft a new release"**
9+
3. Click **"Generate release notes"** — this shows the merged PRs since the last tag, which helps determine the next version (minor vs patch)
10+
4. Choose the tag version (e.g., `v1.0.8`) — the tag will be created when the release is published
11+
5. Review the generated notes, then publish
12+
13+
This method has the advantage that the tag and release are published atomically, and the PR list helps pick the right version number before tagging.
14+
15+
## Method 2: GitHub CLI
16+
17+
```bash
18+
git checkout master
19+
git pull origin master
20+
21+
# Tag and push
22+
git tag v1.0.8
23+
git push origin v1.0.8
24+
25+
# Create release with auto-generated notes
26+
gh release create v1.0.8 --generate-notes
27+
```
28+
29+
## Notes
30+
31+
pflag follows [Semantic Versioning](https://semver.org/). Check the [releases page](https://github.com/spf13/pflag/releases) for the latest tag.

0 commit comments

Comments
 (0)