Developers/Release process

This is a list of steps we perform when creating a new sigrok release:

• Increase the sigrok version number.
  • If there were any backwards-incompatible changes in libsigrok and/or libsigrokdecode, increase their version number too.
• Check if the manpages are up-to-date.
• Test that make distcheck works without errors and creates a .tar.gz file. Unpack that file somewhere.
  • Test that no files are missing, and no extra/unneeded files are in there (non-public header files, *.o files, and that kind of stuff).
  • Test that building sigrok from that unpacked directory works without errors.
  • Test that installing sigrok from there works.
  • Test that running the newly installed sigrok works fine.
  • Test at least the demo driver, one hardware LA, one non-default input- and output driver, and one protocol decoder. The more tests the better, of course.
• Do all of the above tests on all supported platforms if possible, e.g. Linux, Windows, Mac OS X, FreeBSD.
• Write release notes (containing user-visible, important changes) in the wiki.
• If everything works OK, tag the new release in git via: git tag -a v0.1 -m "sigrok 0.1 release".
  • Verify that the tag is placed correctly via git tag or gitk.
  • Then, push it via git push --tags.
• Upload the tarball to SourceForge.
• Announce the new release in various places:
  • Short announce email on the sigrok-devel mailing list, mentioning the new version, and the link to the release notes.
  • Freshmeat
  • ...