Release Process

From Audacity Wiki
Jump to: navigation, search
This page summarises our release process. It also (now) serves as a checklist.

Release Manager

  • Each release has a designated Release Manager (RM), one of the Audacity Team. The Release Manager
    • Manages the whole process, announcing dates, managing freezes, etc.
    • Makes stop/go decisions on the release, and other decisions responding to release issues.
    • RM will probably use a page on wiki such as Next Release for more detailed tracking of what is going into the release, and the schedule.
RM is God
This phrase is a slightly tongue in cheek reference to the fact that the RM decides what is in and what is out for each release. This is a mechanism to reduce argument when there are differences in opinion. The RM is of course expected to be reasonable, and would not have been trusted with the role if they were thought not to be.

Policies

  • P1s, including P1s in the manual, block release. P2s are 'Release Manager decides'.
  • New files provided for download always need a new name, so a "hotfix" to an installer will have a new name.
  • Release Manager can override policies, even releasing with a known P1 bug (though they are very unlikely to do that).

How Tos

The final section of many of the 'Building On' pages have instructions for building release versions.

Other tables etc...


Process (James)

The
Error creating thumbnail: Unable to save thumbnail to destination
and
Error creating thumbnail: Unable to save thumbnail to destination
tick boxes are for 3.0.0
Some of the steps have been reduced here through improved scripts. For example, there is no longer a need to modify the alpha manual before fetching a final version, as the changes are made as it is downloaded.

Early Stages

  • Error creating thumbnail: Unable to save thumbnail to destination
    Candidates for RM step forward.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Team designate a Release Manager.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Release Manager announces he/she is RM.
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM announces proposed timeline and proposed scope
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM increments the version number in:
    • Error creating thumbnail: Unable to save thumbnail to destination
      src/Audacity.h
    • Error creating thumbnail: Unable to save thumbnail to destination
      win/build.txt
    • Error creating thumbnail: Unable to save thumbnail to destination
      audacity.dox
    • Error creating thumbnail: Unable to save thumbnail to destination
      Alpha Manual front page.
    • Error creating thumbnail: Unable to save thumbnail to destination
      Bugzilla front page.
    • Error creating thumbnail: Unable to save thumbnail to destination
      Add to Bugzilla "Version" field.
    • Error creating thumbnail: Unable to save thumbnail to destination
      If needed, increase Copyright year in source code for src/AboutDialog.cpp
  • Error creating thumbnail: Unable to save thumbnail to destination
    Agreed big/dangerous changes go in, such as new libraries, updating compilers or a switch to 64 bit. This is to allow maximum time for issues with these to be worked out
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM checks codesigning certs, to ensure validity at planned time of use.


Middle Stage

  • Error creating thumbnail: Unable to save thumbnail to destination
    Lots of development happens here.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Lots of bug fixing happens here.


The RM has considerable latitude as to exactly what 'String Freeze' and 'Code Freeze' mean.
  • In String Freeze changes which will affect translation should not be made.
    • A consequence is that many features that might need tweaked text as they develop should not be modified during 'String Freeze'.
    • P1 and P2 fixes are OK in 'String Freeze', and RM may welcome any bug fixes.
  • Code Freeze is generally stricter, and generally all changes must be pre-approved.

String Freeze

  • Error creating thumbnail: Unable to save thumbnail to destination
    Proposed string freeze data announced.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Active work on strings to get them ready for translation.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Last minute tweaks to parameters, error messages and features where names/strings will be affected.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Last minute changes to manual.
    • Error creating thumbnail: Unable to save thumbnail to destination
      Spot tests on alpha manual. (in the past, we've been caught by mediawiki upgrades breaking the script)
  • Error creating thumbnail: Unable to save thumbnail to destination
    String Freeze announced. (one or two week's duration).
  • Error creating thumbnail: Unable to save thumbnail to destination
    Translators given .pot files to work on.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Translations updated in Audacity.
  • Error creating thumbnail: Unable to save thumbnail to destination
    End of translation announced.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Write http://wiki.audacityteam.org/wiki/Release_Notes_3.0.0 - a brief user-friendly overview of 3.0.0 (checksums will come later)
  • Error creating thumbnail: Unable to save thumbnail to destination
    Write http://wiki.audacityteam.org/wiki/Release_Notes_3.0.0/Issues - a dynamic complete list of known issues OR fixed issues.
    • Error creating thumbnail: Unable to save thumbnail to destination
      Final tweaks to the above, taking account of last minute P1s and P2s.
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM updates README.txt, creating new "Changes in version" text and moving the old text to the top of CHANGELOG.TXT.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Sanity check installer on Win
  • Error creating thumbnail: Unable to save thumbnail to destination
    Sanity check .dmg on Mac.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Sanity check tarball on Linux
  • Error creating thumbnail: Unable to save thumbnail to destination
    Code Freeze announced.


RCs

  • Error creating thumbnail: Unable to save thumbnail to destination
    Check with manual team that there are no P1s in manual.
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM Reviews all P2s
  • Error creating thumbnail: Unable to save thumbnail to destination
    RM Prepares release announcement on WordPress website (but do not make live)
  • Error creating thumbnail: Unable to save thumbnail to destination
    Freeze manual
  • Error creating thumbnail: Unable to save thumbnail to destination
    In Audacity.h, set AUDACITY_BUILD_LEVEL to 2.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Make RCs (e.g. RC1) and place on FossHub audacity-devel (or drop box if unavailable) [x=05]
    • Error creating thumbnail: Unable to save thumbnail to destination
      RCx Win exe
    • Error creating thumbnail: Unable to save thumbnail to destination
      RCx Win zip
    • Error creating thumbnail: Unable to save thumbnail to destination
      RCx Mac dmg
    • Error creating thumbnail: Unable to save thumbnail to destination
      RCx Linux tarball
    • Error creating thumbnail: Unable to save thumbnail to destination
      RCx Manual zip
  • Error creating thumbnail: Unable to save thumbnail to destination
    Generate the checksums and post at Release Notes 3.0.0
  • Error creating thumbnail: Unable to save thumbnail to destination
    Post the links to the RCs on audacity-devel and the Forum.


We may need to repeat with RC2, RC3, if showstoppers are found.
Gale's notes on testing:
  • Ensure that installers are tested as well as the zips.
    • Test installers installing over an existing install.
    • Test on non-developer machines (in case it relies on features found only on developer machines).

Release

  • Error creating thumbnail: Unable to save thumbnail to destination
    RM: Post final builds/installers (including manual.zip) to FossHub.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Push the updated copy of the manual to https://github.com/audacity/audacity-manual
  • Error creating thumbnail: Unable to save thumbnail to destination
    Tag the release in GitHub.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Check whether any of the version numbers mentioned in 'Early Stages' can already be updated for the next version.
  • Error creating thumbnail: Unable to save thumbnail to destination
    In Audacity.h, set AUDACITY_BUILD_LEVEL to 0.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Lift Code Freeze, String Freeze and Manual Freeze.
  • Error creating thumbnail: Unable to save thumbnail to destination
    In Bugzilla add the new alpha version to the "Version" field.

Release is complete!

Release Announcements

Website Changes

  • Error creating thumbnail: Unable to save thumbnail to destination
    New release announcement on WordPress made live.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Add link to the new post at http://www.audacityteam.org/about/news/
  • Error creating thumbnail: Unable to save thumbnail to destination
    Update mentions of SHA checksums (for installers, .zips, source code, and manual):
  • Error creating thumbnail: Unable to save thumbnail to destination
    Update mentions of program versions, copyright dates, (for installers, .zips, source code, and manual) at:
  • Error creating thumbnail: Unable to save thumbnail to destination
    Ask James to update version checker script at WordPress website.
    • The above is struck out, since we no longer have the scriptlet plug-in on our site.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Ask Buanzo to make an offsite backup of the WordPress database.
    • Error creating thumbnail: Unable to save thumbnail to destination
      Buanzo to do the offsite backup.

Wiki

Social Media etc

  • Error creating thumbnail: Unable to save thumbnail to destination
    RM: Announce the release to audacity-* mailing lists, SourceForge
  • Error creating thumbnail: Unable to save thumbnail to destination
    Peter: Announce to Facebook (and top pin?)
  • Error creating thumbnail: Unable to save thumbnail to destination
    Peter: Update Audacity Wikipedia page
  • Error creating thumbnail: Unable to save thumbnail to destination
    Steve: Make the Forum announcement.
  • Error creating thumbnail: Unable to save thumbnail to destination
    Steve: Update on KVR