Skip to content

Commit 7b4381d

Browse files
committed
[doc] Update release checklist for recent repo reorg
1 parent 7236bef commit 7b4381d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc-project/Release Checklist.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,24 @@ Once `main` seems ready for a release, test it out.
1616
Steps to be done for a release:
1717

1818
1. Change version number in:
19-
a. `cowsay`
20-
a. `cowsay.1.adoc`
19+
a. `bin/cowsay`
20+
a. `man-src/man1/cowsay.1.adoc`
2121
2. Rebuild the man pages with `make man`.
2222
3. Update `CHANGELOG.md` with the release date, and make sure it's up to date with changes.
23-
4. Commit those changes, with a commit message like "v. X.Y.Z".
24-
5. Tag the release in git, in format "vX.Y.Z".
25-
6. Create an X.Y-fixes branch, if this is a major or minor release. (But not for patch releases.)
26-
7. Push the tag and new fixes branch to GitHub.
23+
4. Commit those changes, with a commit message like "v X.Y.Z".
24+
5. Tag the release in git, in format "vX.Y.Z", like `git tag vX.Y.Z`.
25+
6. Create a `patches/vX.Y` branch, if this is a major or minor release. (But not for patch releases.)
26+
7. Push the commits, tag, and new patches branch to GitHub.
2727
8. Create the release in [GitHub Releases](https://github.com/cowsay-org/cowsay/releases).
2828
a. Use the CHANGELOG contents as the release comments.
2929
9. Update the cowsay-org formula over in the [homebrew-cowsay Tap repo](https://github.com/cowsay-org/homebrew-cowsay) to use the new release.
3030
10. Post a comment on the ["Moos & Announcements"](https://github.com/cowsay-org/cowsay/issues/48) issue.
31-
12. Open development on next release.
31+
12. Open development on next release, if this is a major or minor release.
3232
a. Bump the version in files listed above (`cowsay`, `cowsay.1.adoc`), and give it a "-SNAPSHOT" suffix.
3333
b. Update the CHANGELOG with a section for the new release.
3434
c. Rebuild the man pages with `make man`.
35-
d. Commit with a message like "Open development for X.Y.Z", and push.
35+
d. Commit with a message like "Open development for X.Y", and push.
36+
13. Don't bother doing the "open development on next" steps if this is a patch release; just remember to do that if and when you start a patch release for that minor series.
3637

3738
## Build environment
3839

0 commit comments

Comments
 (0)