Differences

This shows you the differences between two versions of the page.

--- dev:release_process [2022/05/15 01:00]
tedfelix [Feature Freeze]
+++ dev:release_process [2024/12/04 19:18] (current)
tedfelix [Clean Up Sourceforge]
@@ Line 4: / Line 4: @@
   - Pick a release date.
-  - Schedule a string freeze and translation period prior.  One week is fine.
+  - Schedule a string freeze and translation period prior.  TWO WEEKS this time as requested by the translators.
   - Schedule a testing (feature freeze) period.  Four weeks is good.
   - Announce the schedule.
@@ Line 12: / Line 12: @@
 You can examine the commit history since the previous release in git using the command line:
-  $ git log --stat --reverse 21.06..master
+  $ git checkout master
+  $ git log --stat --reverse 22.12..
 ...or by using gitk.  With gitk, you can enter the last release number in the "SHA1 ID:" field and it will jump to that tag.  Then work your way backwards (up).
@@ Line 50: / Line 51: @@
 On the eve of the release, send out a reminder for any last minute contributions and translations.
-===== Pending Changes =====
+==== Pending Changes ====
 Check email for any pending changes or requests that need to be included in this release.  Make those changes as appropriate.
-===== File Format Version =====
+==== File Format Version ====
 Determine whether any changes have been made to the .rg file format.  The key routines are:
@@ Line 60: / Line 61: @@
   * ''RosegardenDocument::saveDocument()''
   * ''RoseXmlHandler::startElement()'' (and others in ''RoseXmlHandler'')
+  * ''Composition::toXmlString()'' (and other toXmlString() routines throughout the system)
 Git should ferret out the changes:
-  git log -p -w src/document/RoseXmlHandler.cpp src/document/RosegardenDocument.cpp
+  git log -p -w src/document/RoseXmlHandler.cpp src/document/RosegardenDocument.cpp src/base/Composition.cpp
 If changes have been made to the file format, decide the extent of those changes and what level of file format version update is required.  Update the file format version as appropriate.  See comments on ''FILE_FORMAT_VERSION_POINT'' in RosegardenDocument.cpp.
@@ Line 69: / Line 71: @@
 Changing the point version has no effect on anything as it is ignored.  Use this for things that might be annoying, but won't result in data loss.  Changing the minor version will cause an "incompatibilities" warning on load, but the file will be loaded.  Use this when data might be lost when opening a file with an older version of rg (e.g. new fields have been added).  Changing the major version will cause older versions of rg to refuse to load the file.  Obviously, we should avoid this at all costs.  The chances are good that we will never have to do this.
-===== Update Copyright =====
+==== Update Copyright ====
 Before the June release...  Check for any single copyright years that need to be expanded to a range.  E.g. "Copyright 2020 ...".
@@ Line 86: / Line 88: @@
   git commit -a --author="Copyright Bot <copyright@rosegardenmusic.com>" -m "Update copyright"
-===== Testing =====
+==== Turn Off Logging ====
-On the release date...
+Search for any logging that is turned on and turn it off.
+  grep -rnl --include="*.cpp" "^//#define RG_NO" src
+==== Testing ====
   * From a debug build, do ''make test'' to run unit tests.
+  * The tests may fail due to ASAN.  grep for Totals to see the actual results:
+<file>
+$ grep Totals Testing/Temporary/LastTest.log
+</file>
   * Do a Release build and a regression test.
-===== Finalize CHANGELOG =====
+==== Finalize CHANGELOG ====
   * Add any new changes to the CHANGELOG.
-  * Copy the latest version of the CHANGELOG to a new page [[:start#release_notes|on the wiki]].
+  * Copy the latest version of the CHANGELOG to the wiki.
-===== Turn Off Logging =====
+==== Update appdata ====
-Search for any logging that is turned on and turn it off.
-  grep -rnl --include="*.cpp" "^//#define RG_NO" src
-===== Update appdata =====
 Add release notes for the new release to the appdata file:
   data/appdata/rosegarden.appdata.xml
+Also update the copyright year at the top.
 Validate with appstreamcli:
@@ Line 113: / Line 122: @@
   appstreamcli validate data/appdata/rosegarden.appdata.xml
-===== Update the README =====
+==== Update the README ====
 Update copyright year as needed.
@@ Line 119: / Line 128: @@
 Update anything else that seems like it needs updating.
-===== Update AboutDialog.cpp =====
+==== Update AboutDialog.cpp ====
 Update copyright year as needed.
-===== Update data.qrc =====
+==== Update data.qrc ====
+Get the latest yoshimi.rgd file from https://github.com/lorenzosu/rosegarden_yoshimi_banks/
+Copy it to data/library and make sure it is all lower-case "yoshimi.rgd" to match the previous version.
 Run "scripts/rebuild-qrc-nosvn" to make sure the data.qrc file is up-to-date.
-===== Check Code Name and Version =====
+==== Check Code Name and Version ====
 Check/adjust the code name/version number in CMakeLists.txt.
@@ Line 133: / Line 146: @@
 //The code name/version number should have been bumped after the last delivery, so this should be OK.//
-===== Commit Changes =====
+==== Commit Changes ====
 If needed:
@@ Line 140: / Line 153: @@
   git push
-===== Create tarball =====
+===== Release Day =====
-Download a snapshot from the git repo page on SourceForge.
+==== Create tarball ====
+Finally, on the release date...
+Download a snapshot from the [[https://sourceforge.net/p/rosegarden/git/ci/master/tree/|git repo page on SourceForge]].
 cd to where the snapshot was saved and run the make-release-tarball script with the name of the snapshot:
@@ Line 148: / Line 165: @@
   <path-to-source>/scripts/make-release-tarball <snapshot-name>.zip
-===== Test tarball =====
+==== Test tarball ====
 Sanity test the tarball.  Build and run from it.
-===== Tag the Release =====
+==== Tag the Release ====
 From the sourcebase...
@@ Line 159: / Line 176: @@
   git push --tags
-===== Deliver =====
+==== Deliver ====
+SourceForge
   - Create new version directory on sf
   - Upload the tarball to sf
   - Upload the current version section of the CHANGELOG to sf as README.
-  - Update sourceforge to point to the new version.  Use the "i" icon to the right of the file.  Set "Default Download For:" to Tux.  Set "Download Button:" text to "Rosegarden xx.xx".
+  - Update sourceforge to point to the new version.  Use the "i" icon to the right of the file.  Set "Default Download For:" to Tux.
+GitHub
+  * Create a release.
-===== Update Website =====
+==== Update Website ====
 Update the website to point to the new version.  The website can be updated by committing changes to the website directory in svn.  These are automatically uploaded to the web server.  The webpages use Server Side Includes (SSI), so you'll need to set up a web server to test before uploading changes.
@@ Line 190: / Line 213: @@
 //See https://sourceforge.net/p/rosegarden/code/14701/ for an example.//
+==== Update CMakeLists.txt ====
-===== Update CMakeLists.txt =====
 Bump the version number and codename.
@@ Line 197: / Line 219: @@
 Commit.
+==== Announce ====
-===== Announce =====
   * user list
@@ Line 206: / Line 227: @@
   * etc...?
+===== Post-Release =====
-===== Point Release Process =====
+==== Clean Up Sourceforge ====
-//Discussion uses 21.06.1 as an example.//
+  * Bugs: Go through all "feedback" and close.
+  * Feature Requests: Go through all "feedback" and close.
+  * Patches: Go through all "feedback" and close.
+  * Close any merge requests that were accepted.
-Check out a "point" branch based on the tag you want to start at.
+===== Point Release Process =====
-  git checkout -b point 21.06
+//Discussion uses 22.12.1 as an example.//
-Cherry-pick any commits you need.
+Create a new stable branch based on the tag you want to start at.
-  git cherry-pick 9713720e
+  git checkout -b 22.12-stable 22.12
+Cherry-pick any commits you need from master.
 Go back through the release process carefully.  Some things to watch out for:
@@ Line 224: / Line 251: @@
   - Update the CHANGELOG notes with a complete new point release.
   - Version will need to be adjusted in CMakeLists.txt.
-  - You will need to push the point branch in order to generate a tarball.  You can always delete it later.
+  - You will need to push the stable branch in order to generate a tarball.
   - No need for a new version directory on sf.
   - No need to bump the version number after the tarball.
-Delete the point branch local and remote once the tags are pushed.
 ===== See also =====