Skip to content
Kate Ward edited this page Jan 10, 2016 · 4 revisions

For these steps, it is assumed we are working with release 1.0.0.

Steps:

  • Write release notes.
  • Update version.
  • Finish change log.
  • Check all the code in.
  • Tag the release.
  • Export the release.
  • Create tarball.
  • Create hashes for the tarball and sign with gpg.
  • Update website.

Write Release Notes

This should be pretty self explanatory. Use one of the release notes from a previous release as an example.

Update Version

Edit src/shflags and change the version number in the FLAGS_VERSION variable.

Finish Documentation

Make sure that any remaining changes get put into the CHANGES-X.X.txt file.

Finish writing the RELEASE_NOTES-X.X.X.txt. Once it is finished, run it through the fmt command to make it pretty. (This assumes the lines weren't already wrapped at 80 chars when the file was edited.)

$ fmt -w 80 RELEASE_NOTES-1.0.0.txt >RELEASE_NOTES-1.0.0.txt.new
$ mv RELEASE_NOTES-1.0.0.txt.new RELEASE_NOTES-1.0.0.txt

Check in all the code

This step is pretty self-explanatory.

Create a release

https://github.com/kward/shflags/releases > Draft a new release

  • Version number: vX.X.X
  • Release name: shFlags X.X.X

Clone this wiki locally