You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc-project/Release Checklist.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,24 @@ Once `main` seems ready for a release, test it out.
16
16
Steps to be done for a release:
17
17
18
18
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`
21
21
2. Rebuild the man pages with `make man`.
22
22
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.
27
27
8. Create the release in [GitHub Releases](https://github.com/cowsay-org/cowsay/releases).
28
28
a. Use the CHANGELOG contents as the release comments.
29
29
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.
30
30
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.
32
32
a. Bump the version in files listed above (`cowsay`, `cowsay.1.adoc`), and give it a "-SNAPSHOT" suffix.
33
33
b. Update the CHANGELOG with a section for the new release.
34
34
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.
0 commit comments