| Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
dev:release_process [2023/12/06 12:07]
tedfelix [Finalize CHANGELOG] |
dev:release_process [2024/12/04 19:18] (current)
tedfelix [Clean Up Sourceforge] |
| |
| - Pick a release date. | - 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. | - Schedule a testing (feature freeze) period. Four weeks is good. |
| - Announce the schedule. | - Announce the schedule. |
| On the eve of the release, send out a reminder for any last minute contributions and translations. | 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. | 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: | Determine whether any changes have been made to the .rg file format. The key routines are: |
| 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. | 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 ...". | Before the June release... Check for any single copyright years that need to be expanded to a range. E.g. "Copyright 2020 ...". |
| git commit -a --author="Copyright Bot <copyright@rosegardenmusic.com>" -m "Update copyright" | 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. | * From a debug build, do ''make test'' to run unit tests. |
| * Do a Release build and a regression test. | * Do a Release build and a regression test. |
| |
| ===== Finalize CHANGELOG ===== | ==== Finalize CHANGELOG ==== |
| |
| * Add any new changes to the CHANGELOG. | * Add any new changes to the CHANGELOG. |
| * Copy the latest version of the CHANGELOG to 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: | Add release notes for the new release to the appdata file: |
| appstreamcli validate data/appdata/rosegarden.appdata.xml | appstreamcli validate data/appdata/rosegarden.appdata.xml |
| |
| ===== Update the README ===== | ==== Update the README ==== |
| |
| Update copyright year as needed. | Update copyright year as needed. |
| Update anything else that seems like it needs updating. | Update anything else that seems like it needs updating. |
| |
| ===== Update AboutDialog.cpp ===== | ==== Update AboutDialog.cpp ==== |
| |
| Update copyright year as needed. | 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/ | Get the latest yoshimi.rgd file from https://github.com/lorenzosu/rosegarden_yoshimi_banks/ |
| Run "scripts/rebuild-qrc-nosvn" to make sure the data.qrc file is up-to-date. | 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. | Check/adjust the code name/version number in CMakeLists.txt. |
| //The code name/version number should have been bumped after the last delivery, so this should be OK.// | //The code name/version number should have been bumped after the last delivery, so this should be OK.// |
| |
| ===== Commit Changes ===== | ==== Commit Changes ==== |
| |
| If needed: | If needed: |
| git push | git push |
| |
| ===== Create tarball ===== | ===== Release Day ===== |
| | |
| | ==== 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]]. | Download a snapshot from the [[https://sourceforge.net/p/rosegarden/git/ci/master/tree/|git repo page on SourceForge]]. |
| <path-to-source>/scripts/make-release-tarball <snapshot-name>.zip | <path-to-source>/scripts/make-release-tarball <snapshot-name>.zip |
| |
| ===== Test tarball ===== | ==== Test tarball ==== |
| |
| Sanity test the tarball. Build and run from it. | Sanity test the tarball. Build and run from it. |
| |
| ===== Tag the Release ===== | ==== Tag the Release ==== |
| |
| From the sourcebase... | From the sourcebase... |
| git push --tags | git push --tags |
| |
| ===== Deliver ===== | ==== Deliver ==== |
| | |
| | SourceForge |
| |
| - Create new version directory on sf | - Create new version directory on sf |
| - Upload the tarball to sf | - Upload the tarball to sf |
| - Upload the current version section of the CHANGELOG to sf as README. | - 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. | 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. |
| //See https://sourceforge.net/p/rosegarden/code/14701/ for an example.// | //See https://sourceforge.net/p/rosegarden/code/14701/ for an example.// |
| |
| | ==== Update CMakeLists.txt ==== |
| ===== Update CMakeLists.txt ===== | |
| |
| Bump the version number and codename. | Bump the version number and codename. |
| Commit. | Commit. |
| |
| | ==== Announce ==== |
| ===== Announce ===== | |
| |
| * user list | * user list |
| * etc...? | * etc...? |
| |
| ===== Clean Up Sourceforge ===== | ===== Post-Release ===== |
| | |
| | ==== Clean Up Sourceforge ==== |
| |
| * Bugs: Go through all "feedback" and close. | * Bugs: Go through all "feedback" and close. |
| * Feature Requests: 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. | * Close any merge requests that were accepted. |
| |
