2021-07-08 20:19:57 +02:00
|
|
|
# HarfBuzz release walk-through checklist:
|
2017-10-01 18:05:24 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Open gitk and review changes since last release.
|
2017-10-01 18:05:24 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Print all public API changes:
|
|
|
|
`git diff $(git describe | sed 's/-.*//').. src/*.h`
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Document them in NEWS.
|
|
|
|
All API and API semantic changes should be clearly marked as API additions, API changes, or API deletions.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Document deprecations.
|
|
|
|
Ensure all new API / deprecations are in listed correctly in 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 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
If there's a backward-incompatible API change (including deletions for API used anywhere), that's a release blocker.
|
|
|
|
Do NOT release.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Based on severity of changes, decide whether it's a minor or micro release number bump.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2023-02-11 19:01:06 +01:00
|
|
|
- [ ] Search for 'XSince: REPLACEME' on the repository and replace it with the chosen version for the release, e.g. 'Since: 1.4.7'.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Make sure you have correct date and new version at the top of NEWS file.
|
2018-03-29 01:52:53 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Bump version in line 3 of meson.build and configure.ac.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Do a `meson test -Cbuild` so it both checks the tests and updates hb-version.h (use `git diff` to see if is really updated).
|
|
|
|
|
|
|
|
- [ ] Commit NEWS, meson.build, configure.ac, and src/hb-version.h, as well as any REPLACEME changes you made.
|
|
|
|
The commit message is simply the release number, e. g. "1.4.7"
|
|
|
|
|
Fix various typos
Found via `codespell -q 3 -S ./perf/texts -L actualy,ba,beng,fo,gir,inout,nd,ot,pres,ro,te,teh,timne`
2022-01-16 13:00:53 +01:00
|
|
|
- [ ] Do a `meson dist -Cbuild` that runs the tests against the latest committed changes.
|
2020-07-05 23:23:27 +02:00
|
|
|
If doesn't pass, something fishy is going on, reset the repo and start over.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Tag the release and sign it: e.g. `git tag -s 1.4.7 -m 1.4.7`.
|
|
|
|
Enter your GPG password.
|
2017-10-23 19:10:21 +02:00
|
|
|
|
2021-07-08 20:19:57 +02:00
|
|
|
- [ ] Push the commit and tag out: `git push --follow-tags`.
|