Difference between revisions of "HOWTO-Release"

Jump to navigation Jump to search
53 bytes removed ,  19:01, 9 October 2021
m
(→‎Branching for major release: Update instructions for the user manual)
(6 intermediate revisions by 3 users not shown)
Line 27: Line 27:
** <code>git commit -m "RELEASE: This is 2.2.0pre" -a</code>
** <code>git commit -m "RELEASE: This is 2.2.0pre" -a</code>
* Create annotated tag desc/2.2.0pre on that commit and push
* Create annotated tag desc/2.2.0pre on that commit and push
** <code>git tag -m "Mark 2.2.0pre" desc/2.2.0pre</code>
** <code>git tag -a -m "Mark 2.2.0pre" desc/2.2.0pre</code>
** <code>git push origin tag desc/2.2.0pre branch-2-2:branch-2-2</code>
** <code>git push origin tag desc/2.2.0pre branch-2-2:branch-2-2</code>
* Increase version on master to 2.3.0git, and commit
* Increase version on master to 2.3.0git, and commit
Line 34: Line 34:
** <code>git commit -m "RELEASE: This is 2.3.0git" -a</code>
** <code>git commit -m "RELEASE: This is 2.3.0git" -a</code>
* Create annotated tag desc/2.3.0git on that commit and push
* Create annotated tag desc/2.3.0git on that commit and push
** <code>git tag -m "Mark 2.3.0git" desc/2.3.0git</code>
** <code>git tag -a -m "Mark 2.3.0git" desc/2.3.0git</code>
** <code>git push origin tag desc/2.3.0git master</code>
** <code>git push origin tag desc/2.3.0git master</code>
* Update buildbot
* Update buildbot
Line 41: Line 41:
** 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>
** 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]]
** Update the code on the server and reload the buildbot as described [[Buildbot#Administration_on_server|here]]
** Login on Buildbot, force a build of fetch-stable with cleaning to make sure latest Git is downloaded.
** 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
* Communication
** Update IRC and Discord channel description
** Update IRC and Discord channel description
Line 85: Line 86:
** There is a script <code>devtools/dist-scummvm.sh</code>, which creates them automatically.
** 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>
** 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 ===
=== Branching for minor releases ===
Line 146: Line 147:
** Update <code>data/downloads.xml</code>.
** Update <code>data/downloads.xml</code>.
** Add a news item.
** 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).
**** Translate it to ReleaseNotes.html with https://markdowntohtml.com/
*** 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
** Copy over the release files to FRS
*** Set the OS for the newly uploaded binaries (click on the (i) next to each binary).
*** Set the OS for the newly uploaded binaries (click on the (i) next to each binary).
Line 162: Line 158:
* When 1.7.0 is ready to be announced, make a permanent v1.7.0 tag in git to mark the release
* 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 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>
** <code>git push origin tag v1.7.0</code>
* Also increase the version number on the 1.7.x branch to 1.7.1pre
* Also increase the version number on the 1.7.x branch to 1.7.1pre
Line 169: Line 165:
** <code>git commit -m "RELEASE: This is 1.7.1pre" -a</code>
** <code>git commit -m "RELEASE: This is 1.7.1pre" -a</code>
* Create annotated tag desc/1.7.1pre on that commit and push
* 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>
** <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.
*Add this doc to the Read The Doc admin settings to generate the documentation for this version.
Line 207: Line 203:


* Write a news item for our website (also to be used as a 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).
** Create <tt>data/compatibility/compat-2.1.1.xml</tt>
** Update <tt>data/downloads.xml</tt> file
** Change version constants in <tt>include/Constants.php</tt>
** Change version constants in <tt>include/Constants.php</tt>
** Make sure Sparkle cast is updated (see [[#Signing binaries]])
**Make sure to update the Release information in the datasheet
** Make sure Sparkle appcast is updated (see [[#Signing binaries]])
* Update / notify various sites:  
* Update / notify various sites:  
** Post about the release on our forums
** Post about the release on our forums
329

edits

Navigation menu