Difference between revisions of "HOWTO-Release"

HOWTO-Release (view source)

Revision as of 19:01, 9 October 2021

3,100 bytes added , 19:01, 9 October 2021

m

→‎News & Notification

Rootfather

329

edits

@@ Line 7: / Line 7: @@
 === Preparations ===
-* Making the release plan
+* Make the release plan, normally 1-2 weeks before branching, 3-4 weeks for bug fixing, 2 weeks after tagging before the release
-* Telling people about it, making sure everybody knows what is going on
+** e-mail -devel with the proposed schedule, ask if someone would like to finish some functionality
+** Look through all the open issues on the bugtracker and identify release blockers and nice-to-have-fixed bugs
 * Update the lists of files below, adding new engine data files and such
+* If some games must be fixed before the release, identify those and create a list at [[Release Testing]]
+* Announce the testing period on the main website and copy to the forums and FB
+=== During the release cycle ===
+* E-mail the scummvm-devel list at least weekly with the list of release blockers and nice-to-have-fixed bugs
+* Track daily testing progress and update Wiki if applicable. Normally, we collect playtests on the forums
+* Watch for any potential blockers and pat developers who own the identified blockers
+* Squash as many bugs as possible
 === Branching for major release ===
-* Create a branch for the 1.7.x releases from master, named branch-1-7
+* Create a branch for the 2.2.x releases from master, named branch-2-2
-** <code>git checkout -b branch-1-7 master</code>
+** <code>git checkout -b branch-2-2 master</code>
-* Increase version on branch-1-7 to 1.7.0pre (using <code>devtools/update-version.pl</code>; see below), and commit
+* Increase version on branch-2-2 to 2.2.0pre (using <code>devtools/update-version.pl</code>; see below), and commit
-** <code>devtools/update-version.pl 1 7 0 pre</code>
+** <code>devtools/update-version.pl 2 2 0 pre</code>
-** <code>git commit -m "RELEASE: This is 1.7.0pre" -a</code>
+** <code>git commit -m "RELEASE: This is 2.2.0pre" -a</code>
-* Create annotated tag desc/1.7.0pre on that commit and push
+* Create annotated tag desc/2.2.0pre on that commit and push
-** <code>git tag -m "Mark 1.7.0pre" desc/1.7.0pre</code>
+** <code>git tag -a -m "Mark 2.2.0pre" desc/2.2.0pre</code>
-** <code>git push origin tag desc/1.7.0pre branch-1-7:branch-1-7</code>
+** <code>git push origin tag desc/2.2.0pre branch-2-2:branch-2-2</code>
-* Increase version on master to 1.8.0git, and commit
+* Increase version on master to 2.3.0git, and commit
 ** <code>git checkout master</code>
-** <code>devtools/update-version.pl 1 8 0 git</code>
+** <code>devtools/update-version.pl 2 3 0 git</code>
-** <code>git commit -m "RELEASE: This is 1.8.0git" -a</code>
+** <code>git commit -m "RELEASE: This is 2.3.0git" -a</code>
-* Create annotated tag desc/1.8.0git on that commit and push
+* Create annotated tag desc/2.3.0git on that commit and push
-** <code>git tag -m "Mark 1.8.0git" desc/1.8.0git</code>
+** <code>git tag -a -m "Mark 2.3.0git" desc/2.3.0git</code>
-** <code>git push origin tag desc/1.8.0git master</code>
+** <code>git push origin tag desc/2.3.0git master</code>
+* Update buildbot
+** Edit at the end of [https://github.com/scummvm/dockerized-bb/blob/master/buildbot-config/builds.py builds.py] the line starting with <code>builds.append(ScummVMStableBuild("stable",</code>.
+** Remove the customizations in <code>class ScummVMStableBuild</code> if there were any to make the code inherit from ScummVMBuild without any difference.
+** Edit the file [https://github.com/scummvm/dockerized-bb/blob/master/buildbot-config/platforms.py platforms.py] and remove all specific rules mentioning <code>ScummVMStableBuild</code>
+** Update the code on the server and reload the buildbot as described [[Buildbot#Administration_on_server|here]]
+** Remove the old snapshots: <code> rm /home/buildbot/dockerized-bb/buildbot-data/packages/snapshots/stable/*</code>
+** Login on Buildbot, force a build of fetch-stable with cleaning and packaging to create packages for the new stable.
+* Communication
+** Update IRC and Discord channel description
+** Write a mail to scummvm-devel
 === Testing ===
@@ Line 45: / Line 64: @@
 ** dists/scummvm.rc
 * Review the following documentation files for version and copyright year updates:
-** README
+** README(.md)
-** NEWS
+** NEWS(.md)
 ** COPYRIGHT
+*Make sure ADGF_TESTING flag is cleared on all games.
 * Review the following port specific files for version updates:
 ** backends/platform/ps2/README.PS2
@@ Line 66: / Line 86: @@
 ** There is a script <code>devtools/dist-scummvm.sh</code>, which creates them automatically.
 ** Make sure that porters have write access to the release folder on FRS: <code>chmod 775 <folder></code>
-* Add version to dists/macosx/scummvm_appcast.xml
+* Follow the instructions at [[HOWTO-Release#Signing binaries]] in order to enable updates via (Win)Sparkle
 === Branching for minor releases ===
@@ Line 87: / Line 107: @@
 *** COPYING.FREEFONT
 *** COPYING.LGPL
+*** COPYING.OFL
 *** COPYRIGHT
-*** NEWS
+*** NEWS(.md)
-*** README (generic ScummVM one)
+*** README(.md) (generic ScummVM one)
 *** localized NEWS and README files (from doc/) (optional)
 *** scummmodern.zip (from gui/themes directory) (if your port uses new GUI)
 *** scummclassic.zip (from gui/themes directory) (if your port uses new GUI)
+*** scummremastered.zip (from gui/themes directory) (if your port uses new GUI)
 *** translations.dat (from gui/themes directory)
 *** pred.dic (from dists directory)
 *** access.dat (from dists/engine-data)
+*** access.dat (from dists/engine-data)
+*** cryomni3d.dat (from dists/engine-data)
 *** drascula.dat (from dists/engine-data)
+*** fonts.dat (from dists/engine-data)
 *** hugo.dat (from dists/engine-data)
 *** kyra.dat (from dists/engine-data)
@@ Line 104: / Line 129: @@
 *** queen.tbl (from dists/engine-data)
 *** sky.cpt (from dists/engine-data)
+*** supernova.dat (from dists/engine-data)
 *** teenagent.dat (from dists/engine-data)
+*** titanic.dat (from dists/engine-data)
 *** tony.dat (from dists/engine-data)
 *** toon.dat (from dists/engine-data)
+*** ultima.dat (from dists/engine-data)
 *** wintermute.zip (from dists/engine-data)
+*** xeen.ccs (from dists/engine-data)
 *** your build binary
@@ Line 118: / Line 147: @@
 ** Update <code>data/downloads.xml</code>.
 ** Add a news item.
-** Sparkle automatic updates
+** Follow the instructions at [https://wiki.scummvm.org/index.php?title=HOWTO-Release#Signing_binaries HOWTO-Release#Signing binaries] in order to enable updates via (Win)Sparkle
-*** Create a ReleaseNotes file on FRS with the changes from this release (from NEWS file).
-*** Sign the macOS and Win32 binaries with our private key for Sparkle
-*** Update the scummvm_appcast.xml file in scummvm/dist/macosx/.
-*** Copy the app cast file on the website as appcasts/macosx/release.xml
 ** Copy over the release files to FRS
 *** Set the OS for the newly uploaded binaries (click on the (i) next to each binary).
@@ Line 133: / Line 158: @@
 * When 1.7.0 is ready to be announced, make a permanent v1.7.0 tag in git to mark the release
 ** <code>git checkout branch-1-7-0</code>
-** <code>git tag -m "Tag v1.7.0" v1.7.0</code>
+** <code>git tag -a -m "Tag v1.7.0" v1.7.0</code>
 ** <code>git push origin tag v1.7.0</code>
 * Also increase the version number on the 1.7.x branch to 1.7.1pre
@@ Line 140: / Line 165: @@
 ** <code>git commit -m "RELEASE: This is 1.7.1pre" -a</code>
 * Create annotated tag desc/1.7.1pre on that commit and push
-** <code>git tag -m "Mark 1.7.1pre" desc/1.7.1pre</code>
+** <code>git tag -a -m "Mark 1.7.1pre" desc/1.7.1pre</code>
 ** <code>git push origin tag desc/1.7.1pre branch-1-7:branch-1-7</code>
+*Add this doc to the Read The Doc admin settings to generate the documentation for this version.
 === Creating source tarballs ===
@@ Line 152: / Line 178: @@
 Then upload the resulting scummvm-1.9.0.tar.gz, scummvm-1.9.0.tar.bz2, scummvm-1.9.0.tar.xz and scummvm-1.9.0.tar.zip to the FRS.
+=== Signing binaries ===
+Put tarballs into directory <tt>archives/</tt>, run:
+<syntaxhighlight lang="bash">
+bin/generate_appcast archives/
+bin/old_dsa_scripts/sign_update archives/scummvm-2.1.1-win32.exe dsa_priv.pem
+bin/old_dsa_scripts/sign_update archives/scummvm-2.1.1-macosx.dmg dsa_priv.pem
+</syntaxhighlight>
+The first line will generate file <tt>archives/release.xml</tt>. The following ones will just spit out DSA signatures.
+Copy/paste signatures to <tt>dists/macosx/scummvm_appcast.xml</tt> in the main git repo.
+Then run:
+<syntaxhighlight lang="bash">
+make publish-appcast
+cd ../scummvm-web
+git commit -m 'WEB: Sync appcast' -a
+</syntaxhighlight>
 === News & Notification ===
 Write a news blurb (or rather multiple to be used in the following). Usually, you want a bit longer one for the website, a list for Versiontracker, something with proper english sentences for Freshmeat, etc....
-* Write a news item for our website (also to be used as template for news items on other sites).
+* Write a news item for our website (also to be used as a template for news items on other sites).
-* Update / notify various sites:
+** Change version constants in <tt>include/Constants.php</tt>
-** Create a SF.net news item
+**Make sure to update the Release information in the datasheet
-** [http://freecode.com/ Freecode]
+** Make sure Sparkle appcast is updated (see [[#Signing binaries]])
+* Update / notify various sites:
 ** Post about the release on our forums
-** ... more ?
+** Post about the release on Facebook
 * Put the updated web site online
-* Update IRC channel topic
+* Update IRC and Discord channel topics
 === Updating the wiki ===

Difference between revisions of "HOWTO-Release"

HOWTO-Release (view source)

Revision as of 19:01, 9 October 2021

Navigation menu

Search