Developers/Release process

From sigrok
Revision as of 22:53, 18 January 2011 by Uwe Hermann (talk | contribs) (Created page with '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…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.
  • 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
    • ...