-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The only change is updating the HTSCODECS_VERSION macro in htscodecs.h also. I forgot to do this for 1.1, so this is a tiny change. (The NEWS file just glosses over the existance of 1.1 and jumps straight to 1.1.1.) My apologies. Also added a MAINTAINERS.md file as an aide memoir for future releases.
- Loading branch information
1 parent
1e13f56
commit d13043b
Showing
5 changed files
with
62 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
Notes to maintainers for building releases. | ||
This is best done as a release PR so we can check it first. | ||
|
||
1. Places to update the version number include: | ||
|
||
- htscodecs/htscodecs.h (used for program introspection) | ||
|
||
- configure.ac AC_INIT macro | ||
|
||
- configure.ac VERS_CURRENT, VERS_REVISION and VERS_AGE variables. | ||
See the long comment above for instructions of how these change. | ||
|
||
- NEWS and README files. | ||
|
||
|
||
2. Ensure NEWS and README files are up to date. NEWS is a git log | ||
summary. README is probably just a version number update, unless | ||
anything major needs bringing up. | ||
|
||
- At time of merging, set the date at the top of NEWS. | ||
|
||
|
||
3. Test it all. | ||
- Push to github PR so the CI can validate for us. | ||
|
||
- make distcheck | ||
This also makes the tarball htscodecs-${vers}.tar.gz. | ||
|
||
|
||
4. Merge into master | ||
|
||
|
||
5. Add an annotated tag with minimal message, eg: | ||
|
||
- git tag -a v1.1 -m v1.1 | ||
|
||
|
||
6. Push master and --tags upstream to github | ||
|
||
|
||
7. Make a new release on github. | ||
|
||
- Title: "htscodecs ${vers}" | ||
|
||
- Message: this is just a copy of NEWS. | ||
It's already in Markdown format, but double check the preview panel. | ||
|
||
- Upload the tarball produced from distcheck to the assets. | ||
|
||
|
||
8. Finally, consider updating any packages that use this as a | ||
submodule to ensure they have the latest tagged release. | ||
|
||
This will invariably help OS distributions keep their package | ||
dependencies neatly in sync. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters