Skip to content

Commit 8e491f4

Browse files
committed
doc: Tweak release doc to match my current practice and add a link
In particular the "Unreleased" thing is how we've long done it in zulip-mobile.
1 parent 87d07b7 commit 8e491f4

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/release.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,20 @@
66
Flutter and packages dependencies, do that first.
77
For details of how, see our README.
88

9-
* Add an entry in `docs/changelog.md`. Commit that change.
9+
* Write an entry in `docs/changelog.md`, as "Unreleased".
10+
Commit that change.
1011

1112
* Increment the version number in `pubspec.yaml`:
1213

1314
Take the line near the top that looks like `version: 0.0.42+42`,
1415
and increment both of the last two numbers.
1516
They should remain equal to each other.
1617

17-
* Commit the version-number change, and tag:
18-
`git commit pubspec.yaml -m 'version: Bump version to 0.0.NNN'
18+
Edit the "Unreleased" heading in `docs/changelog.md` to the
19+
new version number.
20+
21+
* Commit the version-number changes, and tag:
22+
`git commit pubspec.yaml docs/changelog.md -m 'version: Bump version to 0.0.NNN'
1923
&& git tag v0.0.NNN`
2024

2125
* Push the tag to our central repo: `git push origin main v0.0.NNN`
@@ -100,7 +104,8 @@
100104
101105
* Android via GitHub:
102106
103-
* Create a GitHub release, named the same as the tag.
107+
* [Create a GitHub release](https://github.com/zulip/zulip-flutter/releases/new),
108+
named the same as the tag.
104109
105110
* For the release notes, use `tools/format-changelog notes`,
106111
and fix formatting as needed.
@@ -146,6 +151,9 @@
146151
GitHub or Zulip) and @-mention the individuals who asked for the
147152
change.
148153
154+
In particular, for each fixed issue 123, do a Zulip search for
155+
"f123". This efficiently finds any threads that mentioned "#F123".
156+
149157
150158
## One-time or annual setup
151159

0 commit comments

Comments
 (0)