Difference between revisions of "Release Process"

From Audacity Wiki
Jump to: navigation, search
m (Release Candidates: Changed to a numeric checklist, to facilitate different people saying which numbers they're taking on.)
(Release Announcements: not us any more)
 
(225 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Template:Audacity Devel}}
+
{{intro|This page summarises our release process. It also (now) serves as a checklist.}}
 
 
{{Intro|This page defines the Audacity release process.|}}
 
 
 
  
 
== Release Manager ==
 
== Release Manager ==
* Each release has a designated Release Manager, one of the Technical Leaders.  The 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.
 
** Manages the whole process, announcing dates, managing freezes, etc.
** Has final say on when a release candidate is good enough for actual release.
+
** <b>Makes stop/go decisions on the release, and other decisions responding to release issues.</b>
** Release Manager (and occasionally other Technical Leaders) are the only people allowed to change this page during the release cycleOthers should only add suggestions between release cycles, and not change the basic process definition.
+
** 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.
 +
{{note|1='''RM is God'''<br>
 +
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 ==
 
== Policies ==
* String freeze means no changes are made to any of the translatable strings within Audacity.
+
* P1s, including P1s in the manual, block release. P2s are 'Release Manager decides'.
* Code freeze means the only code allowed to be changed is to fix release-blocking bugs discovered in testing.
+
* New files provided for download always need a new name, so a "hotfix" to an installer will have a new name.
* We have a firm policy of never providing for download two files with the same name and different contents, i.e., 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).
* Release Manager decides what to do if we post a bad download, and what to do regarding testing and posting hotfixes. (Sometimes, they may not require the same testing cycle as true releases get, since that delay reduces their value.)
+
 
 +
==How Tos==
 +
The final section of many of the 'Building On' pages have instructions for building release versions.
 +
 
 +
* '''[[Building The Manual]]''' - For the manual obviously
 +
* '''[[Building On Windows]]''' - We produce both an installer and a zip file
 +
* '''[[Building On Mac]]''' - We just produce a .dmg
 +
* '''[[Building On Linux]]''' - We produce a minimal tarball
 +
 
 +
'''Other tables etc...'''
 +
* '''[https://md5file.com/calculator Online Checksum Calculator]''' - For SHA-256's
 +
* <s>'''[[Version Checking Scriptlet]]''' - For our website downloads page</s> no longer used
 +
* <s>'''[[Dynamic Bug List]]''' - For release notes pages</s> no longer used
 +
 
 +
== Process (James) ==
 +
'''''The {{done}} and {{todo}} tick boxes are for 3.0.3'''''{{note|1=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 ===
 +
* {{todo}} Candidates for RM step forward.
 +
* {{todo}} Team designate a Release Manager.
 +
* {{todo}} Release Manager announces he/she is RM.
 +
* {{todo}} RM announces proposed timeline and proposed scope
 +
* {{todo}} RM increments the version number in:
 +
** {{done}} src/Audacity.h
 +
** {{done}} win/build.txt
 +
** {{done}} audacity.dox
 +
** {{done}} Alpha Manual front page.
 +
** {{done}} Bugzilla front page.
 +
** {{done}} Add to Bugzilla "Version" field.
 +
** {{done}} If needed, increase Copyright year in source code for src/AboutDialog.cpp
 +
* {{todo}} 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''
 +
* {{todo}} RM checks codesigning certs, to ensure validity at planned time of use.
 +
 
 +
 
 +
=== Middle Stage===
 +
* {{todo}} ''Lots of development happens here.''
 +
* {{todo}} ''Lots of bug fixing happens here.''
 +
 
 +
{{note|1=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 ===
 +
 
 +
* {{todo}} Proposed string freeze data announced.
 +
* {{todo}} Active work on strings to get them ready for translation. 
 +
* {{todo}} Last minute tweaks to parameters, error messages and features where names/strings will be affected.
 +
* {{todo}} Last minute changes to manual.
 +
** {{todo}} Spot tests on alpha manual. ''(in the past, we've been caught by mediawiki upgrades breaking the script)''
 +
* {{todo}} '''String Freeze announced.'''  ''(one or two week's duration)''.
 +
* {{todo}} Translators given .pot files to work on. 
 +
* {{todo}} Translations updated in Audacity.
 +
* {{todo}} End of translation announced.
 +
* {{todo}} Write http://wiki.audacityteam.org/wiki/Release_Notes_3.0.3 - a brief user-friendly overview of 3.0.2 (checksums will come later)
 +
* <s>{{todo}} Write http://wiki.audacityteam.org/wiki/Release_Notes_3.0.3/Issues - a dynamic complete list of known issues OR fixed issues.</s>
 +
** {{todo}} Final tweaks to the above, taking account of last minute P1s and P2s.
 +
* {{todo}} RM updates README.txt, creating new "Changes in version" text and moving the old text to the top of CHANGELOG.TXT.
 +
* {{todo}} Sanity check installer on Win
 +
* {{todo}} Sanity check .dmg on Mac.
 +
* {{todo}} Sanity check tarball on Linux
 +
* {{todo}} '''Code Freeze''' announced.
 +
 
 +
 
 +
=== RCs ===
 +
 
 +
* {{todo}} Check with manual team that there are no P1s in manual.
 +
* {{todo}} RM Reviews all P2s
 +
* {{todo}} RM Prepares release announcement on WordPress website  ''(but do not make live)''
 +
* {{todo}} '''Freeze manual'''
 +
* {{todo}} Fetch a copy of the manual.
 +
* {{todo}} In Audacity.h, set '''AUDACITY_BUILD_LEVEL to 2'''.
 +
* {{todo}} Make RCs (e.g. RC1) and place on FossHub audacity-devel ''(or drop box if unavailable)'' [x=01]
 +
** {{todo}} RCx Win exe
 +
** {{todo}} RCx Win zip
 +
** {{todo}} RCx Mac dmg
 +
** {{todo}} RCx Linux tarball
 +
** {{todo}} RCx Manual zip
 +
* {{todo}} Generate the checksums and post at [[Release Notes 3.0.2]]
 +
* {{todo}} Post the links to the RCs on audacity-devel and the Forum.
  
== Process ==
+
{{note|1=We may need to repeat with RC2, RC3, if showstoppers are found.}}{{note|1='''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).
 +
}}
  
# Tech Leaders decide on a release date and time. For a beta release, string freeze and code freeze for initial release candidate (rc) are one week before the specified release date. For a stable release, string freeze is two weeks before initial rc, and code freeze is one week before.
+
=== Release ===
# Tech Leaders designate a Release Manager.
 
# Release Manager checks with people that we are 'ready to go' (builders for all three platforms, no known release blockers, no blocking issues around documentation or translation, someone to do release notes etc..)
 
# Release Manager announces he/she is RM, specifies release date and time, and freeze dates and times, on audacity-devel and audacity-quality. All these announcements should start a new thread with a clear header, e.g., "code freeze for 1.3.13rc1".
 
# At string freeze, the audacity.pot file needs to be updated with the frozen strings, and posted to audacity.sourceforge.net. For a Stable release, we would batch update the .po files with the updated messages from the .pot file. See [[Translating Audacity#Updating existing translations|Translating Audacity]].
 
# Immediately before the code freeze:
 
## In Audacity.h, set IS_ALPHA to 0. If it is to be a stable release, also set IS_BETA to 0.
 
## Bump the version number on the front page of the [http://manual.audacityteam.org/index.php?title=Main_Page Manual].
 
## Prepare and commit README.txt, creating new "Changes in version" text and moving the old text to the top of Section 6 "Previous Changes". The list of Known Issues at time of release is now prepared in the Wiki [[Release Notes]] for that version, so just link to that page in the README.
 
# After the code is frozen, build and test release candidates for all platforms. Details in Release Candidates section, below. Code is frozen and testing takes place for 48 hours. If any release-blocking bugs are discovered, they are fixed and the next rc builds will be done after the end of that 48 hours. Iterate on this process until the final rc is tested for 48 hours with no release-blocking bugs discovered. (Yes, this process can exceed the designated release date, but it provides at least three 48-hour cycles. It might even be early. Release Manager decides whether to change actual final release date from the target.)
 
# This and the next two steps should be expected to take about 24-36 hours.
 
##Post final builds/installers to audacity.googlecode.com > Downloads.
 
###'''Delete the rc's''' to avoid user confusion and to conserve space.
 
###Set all the new version files to "Deprecated".
 
###Set all the new version files to "Featured".
 
##Post final builds/installers to [https://sourceforge.net/projects/audacity/files/ SourceForge]. (Downloads are no longer served from SourceForge, but some users still look there, so they should be archived there.)
 
###Set the default download for each platform. For each, click on the 'i' button for the file, then check the appropriate checkbox(es) in the "Default Download For:" section. This means that on the SorceForge Audacity project page, the big green download button offers the Windows Unicode installer, on Mac the DMG, and on Linux the minsrc tarball.
 
# Update the zipped manual stored at [http://manual.audacityteam.org/help.zip http://manual.audacityteam.org/help.zip] using the updated Manual from the source tree. Test unzipping the Manual before sending it. When unzipped, it should produce a "help" folder with the "manual" folder inside that.
 
# Do the Release Announcements per that section, below. Copy the new "Changes in version" text from the README into the Wiki page.
 
# Tag the release, per that section, below.
 
# Lift string and code freezes.
 
# Release is complete. In Audacity.h, set IS_ALPHA to 1, and if it was a stable release, also set IS_BETA to 1. Increment the version number.
 
  
== Release Candidates ==
+
* {{todo}} Push the updated copy of the manual to [https://github.com/audacity/audacity-manual https://github.com/audacity/audacity-manual]
 +
* {{todo}} RM: Post final builds/installers (including manual.zip) to FossHub.
 +
* {{todo}} RM: Post final builds/installers (including manual.zip) to GitHub.
 +
* {{todo}} Tag the release in GitHub.
 +
* {{todo}} Check whether any of the version numbers mentioned in 'Early Stages' can already be updated for the next version.
 +
* {{todo}} In Audacity.h, '''set AUDACITY_BUILD_LEVEL to 0'''.
 +
* {{todo}} '''Lift Code Freeze, String Freeze and Manual Freeze. '''
 +
* {{todo}} In Bugzilla add the new alpha version to the "Version" field.
 +
* {{todo}} In Bugzilla update the message of the day to state the new version.
  
# Build release candidate:
+
'''Release is complete!'''
## Windows [[Release_Process/Win|Installer]] (includes manual)
 
## Windows [[Release_Process/Win#Create the zip version|Zip]] (no manual)
 
## Mac DMG (includes manual)
 
## Mac Zip (no manual)
 
## Linux [[Building Release Tarballs| Full and Minimal source tarballs]] (single script does both).
 
# Upload to Google Code so that people can download them for testing. Post the links to these on audacity-devel, audacity-quality, and the Forum. Within the code freeze period, monitor the Forum, and report bugs to audacity-devel as well as in the Forum thread. Raise a Px Bugzilla issue if the problem is not to be fixed for release.
 
# 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 Announcements ==
 
== Release Announcements ==
* Create the website release announcement and list of changes from the committed README.txt. Commit the website changes to SVN and [[Editing audacity.sourceforge.net#Updating the web server from SVN|push to the website]] so that it goes into the audacity_website.pot file and is then available to translators.
 
*Go to the Release Notes for the previous version, and change the "intro" div to give the dates the version was current for. Add a link to the Release Notes for the version just released.
 
*Clear the text on http://wiki.audacityteam.org/wiki/Known_Issues .
 
*Write the http://wiki.audacityteam.org/wiki/Developer_News news item.
 
*Update http://wiki.audacityteam.org/wiki/Audacity_Wiki_Home_Page for that developer news item, delete the oldest news item, and update the version number for links to "Downloadable Beta Manual" and "Online alpha Manual".
 
* Make the Forum announcement.
 
* Announce the release to mailing lists, GoogleCode Wiki, [https://sourceforge.net/news/?group_id=6235 SourceForge] and the [http://audacity.sourceforge.net/#announce Dreamhost list].
 
  
== Tag the Release ==
+
=== Website Changes ===
 +
* {{todo}} New release announcement on WordPress made live.
 +
* {{todo}} Add link to the new post at http://www.audacityteam.org/about/news/
 +
* {{todo}} Update mentions of SHA checksums (for installers, .zips, source code, and manual):
 +
* {{todo}} Update mentions of program versions, copyright dates, (for installers, .zips, source code, and manual) at:
 +
** {{todo}} http://www.audacityteam.org/about/citations-screenshots-and-permissions/
 +
** {{todo}} http://www.audacityteam.org/copyright/
 +
** {{todo}} http://www.audacityteam.org/download/online-safety-when-downloading/
 +
** {{todo}} http://www.audacityteam.org/download/windows/
 +
** {{todo}} http://www.audacityteam.org/download/mac/
 +
** {{todo}} http://www.audacityteam.org/download/source/
 +
** {{todo}} The version number on the front page (via theme edits).
 +
** {{todo}} The version numbers on download pages (via widget edits).
 +
* <s>{{todo}} Ask '''James''' to update [[Version Checking Scriptlet|version checker script]] at WordPress website.</s>
 +
** The above is struck out, since we no longer have the scriptlet plug-in on our site.
 +
* {{todo}} make an offsite backup of the WordPress database. 
 +
** {{todo}} ensure there is an offsite backup.
  
This is the SVN command to use, per Richard's advice; it performs a minimal copy server-side instead of copying the whole thing from your working copy and thus runs very quickly:
+
=== Wiki ===
 +
* {{todo}} Update the Audacity Versions page at https://wiki.audacityteam.org/wiki/Audacity_Versions
  
svn copy -m "Tag release of Audacity 1.3.x" <nowiki>https://audacity.googlecode.com/svn/audacity-src/trunk/ https://audacity.googlecode.com/svn/audacity-src/tags/Audacity_1_3_x</nowiki>
+
=== Social Media etc===
 +
* {{todo}} '''RM:''' Announce the release to audacity-devel mailing list, [https://sourceforge.net/news/?group_id=6235 SourceForge]
 +
* {{todo}}  Announce to Facebook (and top pin?)
 +
* {{todo}}  Update Audacity Wikipedia page
 +
* {{todo}}  Make the Forum announcement.
 +
* {{todo}}  Update on KVR
  
 
[[Category:For Developers]][[Category:Quality]]
 
[[Category:For Developers]][[Category:Quality]]

Latest revision as of 11:54, 9 July 2021

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 Done.png and ToDo.png tick boxes are for 3.0.3

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

  • ToDo.png Candidates for RM step forward.
  • ToDo.png Team designate a Release Manager.
  • ToDo.png Release Manager announces he/she is RM.
  • ToDo.png RM announces proposed timeline and proposed scope
  • ToDo.png RM increments the version number in:
    • Done.png src/Audacity.h
    • Done.png win/build.txt
    • Done.png audacity.dox
    • Done.png Alpha Manual front page.
    • Done.png Bugzilla front page.
    • Done.png Add to Bugzilla "Version" field.
    • Done.png If needed, increase Copyright year in source code for src/AboutDialog.cpp
  • ToDo.png 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
  • ToDo.png RM checks codesigning certs, to ensure validity at planned time of use.


Middle Stage

  • ToDo.png Lots of development happens here.
  • ToDo.png 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

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


RCs

  • ToDo.png Check with manual team that there are no P1s in manual.
  • ToDo.png RM Reviews all P2s
  • ToDo.png RM Prepares release announcement on WordPress website (but do not make live)
  • ToDo.png Freeze manual
  • ToDo.png Fetch a copy of the manual.
  • ToDo.png In Audacity.h, set AUDACITY_BUILD_LEVEL to 2.
  • ToDo.png Make RCs (e.g. RC1) and place on FossHub audacity-devel (or drop box if unavailable) [x=01]
    • ToDo.png RCx Win exe
    • ToDo.png RCx Win zip
    • ToDo.png RCx Mac dmg
    • ToDo.png RCx Linux tarball
    • ToDo.png RCx Manual zip
  • ToDo.png Generate the checksums and post at Release Notes 3.0.2
  • ToDo.png 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

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

Release is complete!

Release Announcements

Website Changes

Wiki

Social Media etc

  • ToDo.png RM: Announce the release to audacity-devel mailing list, SourceForge
  • ToDo.png Announce to Facebook (and top pin?)
  • ToDo.png Update Audacity Wikipedia page
  • ToDo.png Make the Forum announcement.
  • ToDo.png Update on KVR