2017-10-01 16:05:24 +00:00
|
|
|
HarfBuzz release walk-through checklist:
|
|
|
|
|
|
|
|
|
|
1. Open gitk and review changes since last release.
|
|
|
|
|
|
2017-10-23 17:10:21 +00:00
|
|
|
* `git diff $(git describe | sed 's/-.*//').. src/*.h` prints all public API
|
|
|
|
|
changes.
|
|
|
|
|
|
|
|
|
|
Document them in NEWS. All API and API semantic changes should be clearly
|
|
|
|
|
marked as API additions, API changes, or API deletions. Document
|
2018-06-12 23:32:04 +00:00
|
|
|
deprecations. Ensure all new API / deprecations are in listed correctly in
|
2018-10-30 22:52:26 +00:00
|
|
|
docs/harfbuzz-sections.txt. If release added new API, add entry for new
|
|
|
|
|
API index at the end of docs/harfbuzz-docs.xml.
|
2017-10-23 17:10:21 +00:00
|
|
|
|
|
|
|
|
If there's a backward-incompatible API change (including deletions for API
|
|
|
|
|
used anywhere), that's a release blocker. Do NOT release.
|
|
|
|
|
|
|
|
|
|
2. Based on severity of changes, decide whether it's a minor or micro release
|
|
|
|
|
number bump,
|
|
|
|
|
|
2018-03-28 23:52:53 +00:00
|
|
|
3. Search for REPLACEME on the repository and replace it with the chosen version
|
|
|
|
|
for the release.
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2018-03-28 23:52:53 +00:00
|
|
|
4. Make sure you have correct date and new version at the top of NEWS file,
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2020-05-11 19:33:17 +00:00
|
|
|
5. Bump version in configure.ac line 3 and meson.build line 4.
|
2018-03-28 23:52:53 +00:00
|
|
|
|
|
|
|
|
6. Do "make distcheck", if it passes, you get a tarball.
|
2017-10-01 16:05:24 +00:00
|
|
|
Otherwise, fix things and commit them separately before making release,
|
2018-08-09 04:54:08 +00:00
|
|
|
Note: Check src/hb-version.h and make sure the new version number is
|
|
|
|
|
there. Sometimes, it does not get updated. If that's the case,
|
2018-10-19 18:15:35 +00:00
|
|
|
"touch configure.ac" and rebuild. Also check that there is no hb-version.h
|
|
|
|
|
in your build/src file. Typically it will fail the distcheck if there is.
|
|
|
|
|
That's what happened to 2.0.0 going out with 1.8.0 hb-version.h... So, that's
|
|
|
|
|
a clue.
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2019-03-29 21:30:02 +00:00
|
|
|
7. Now that you have release files, commit NEWS, configure.ac, and src/hb-version.h,
|
2018-06-05 22:17:39 +00:00
|
|
|
as well as any REPLACEME changes you made. The commit message is simply the
|
|
|
|
|
release number. Eg. "1.4.7"
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2020-06-06 15:46:50 +00:00
|
|
|
8. "make dist" again to get a tarball with your new commit in the ChangeLog.
|
2019-03-29 21:30:02 +00:00
|
|
|
|
2018-03-28 23:52:53 +00:00
|
|
|
9. Tag the release and sign it: Eg. "git tag -s 1.4.7 -m 1.4.7". Enter your
|
2020-06-06 15:46:50 +00:00
|
|
|
GPG password.
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2020-06-01 08:28:31 +00:00
|
|
|
10. Build win32 bundle. See [README.mingw.md](README.mingw.md).
|
2017-10-23 17:10:21 +00:00
|
|
|
|
2020-05-11 19:33:17 +00:00
|
|
|
11. Quickly double-check the size of the .tar.xz and .zip files against their
|
|
|
|
|
previous releases to make sure nothing bad happened.
|
2017-10-23 17:10:21 +00:00
|
|
|
They should be in the ballpark, perhaps slightly larger. Sometimes they
|
|
|
|
|
do shrink, that's not by itself a stopper.
|
|
|
|
|
|
2020-05-15 07:44:23 +00:00
|
|
|
12. Push the commit and tag out: "git push --follow-tags". Go to GitHub release
|
|
|
|
|
page [here](https://github.com/harfbuzz/harfbuzz/releases), edit the tag,
|
|
|
|
|
upload artefacts and NEWS entry and save.
|
