Skip to content

Commit

Permalink
Update the release checklist
Browse files Browse the repository at this point in the history
in order to further reduce the effort made at each release
  • Loading branch information
dpiparo committed Apr 3, 2024
1 parent 5531812 commit 2923f40
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions for_developers/release_checklist/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,33 +59,37 @@ This assumes you try to create `v6-32-00-patches`, adjust accordingly.
### Produce a new ROOT release

1. Get the 'green' light from all main developers
1. Check that all the [Jenkins nightlies](https://lcgapp-services.cern.ch/root-jenkins/view/ROOT%20Nightly/){:target="_blank"} and [Jenkins release builds](https://lcgapp-services.cern.ch/root-jenkins/view/Releases/){:target="_blank"} builds are green
1. Check that all the [nightlies](https://github.com/root-project/root/actions?query=event%3Aschedule){:target="_blank"} builds are green
1. Run with `valgrind` on `python tutorials/pyroot/hsimple.py`, `tree/dataframe/test/dataframe_concurrency`, and `./roofit/roofit/test/testRooParamHistFunc`; make sure no memory errors are reported after applying `--suppressions=$ROOTSYS/etc/valgrind-root.supp` and `--suppressions=$ROOTSYS/etc/valgrind-root-python.supp`
1. Verify that no performance regressions exist in the [benchmark system](https://rootbnch-grafana-test.cern.ch/){:target="_blank"}
1. **MUST** update the potentially security relevant builtin externals: `openssl` (see `builtins/openssl/CMakeLists.txt`), `net/http/civetweb`, xrootd (see `builtins/xrootd/CMakeLists.txt`), davix (see `builtins/davix/CMakeLists.txt`).
1. Should update other builtin externals, see `builtins/`
1. If this is not a development release nor a release candidate, update the release notes in `README/ReleaseNotes/vXXX/index.md`. If this is a patch release, edit release notes patches section at the end of the document.
- Insert the list of fixed bugs and enhancements etc behind the general release announcement for that version. They come from both Jira and Github:
- Jira project management
* Create the next patch ("6.32/02") or major ("6.24/00") version in the [project configuration](https://sft.its.cern.ch/jira/plugins/servlet/project-config/ROOT/versions){:target="_blank"}
* Create the next patch ("6.32.02") or major ("6.24/00") version in the [project configuration](https://sft.its.cern.ch/jira/plugins/servlet/project-config/ROOT/versions){:target="_blank"}
* 'Release' the version you want to release, assigning open issues to the next patch or major release.
* From the [list the versions in JIRA](https://sft.its.cern.ch/jira/projects/ROOT?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released){:target="_blank"}, select the version and then 'release notes'
- GitHub project management
* Run `python3 ./get_solved_issues.py --project-name 6.32/02` to copy and paste the fixed GitHub issues into the release notes.
* Go to this version's [GitHub project](https://github.com/root-project/root/projects/) (e.g. [Fixed in 6.32/08](https://github.com/root-project/root/projects/10) when releasing 6.32/08). On the right column header, click "<" until the column header reads "Menu" with a hamburger menu next to it. Below, to the right, you see "...". Click, select "Copy", and enter the name of the *next* production or patch release. Don't forget to remove the leading "[COPY]"! Owner is `root-project/root`.
* Run `python3 ./get_solved_issues.py --project-name v6.32.00` to copy and paste the fixed GitHub issues into the release notes.
* Go to this version's [GitHub project](https://github.com/root-project/root/projects/) (e.g. [Fixed in 6.32.08](https://github.com/root-project/root/projects/10) when releasing 6.32.08). On the right column header, click "<" until the column header reads "Menu" with a hamburger menu next to it. Below, to the right, you see "...". Click, select "Copy", and enter the name of the *next* production or patch release. Don't forget to remove the leading "[COPY]"! Owner is `root-project/root`.
* In "..." next to the currently to-be-released version's [GitHub project](https://github.com/root-project/root/projects/), hit "Close project". (No more bugs will be fixed in it: we are releasing it!)
- Commit your new release notes: `git commit README/ReleaseNotes/v632/index.md`
1. Update the version number
- Since 6.30: edit `core/foundation/inc/ROOT/RVersion.hxx`.
- Before 6.30:
- Edit `build/version_number`. For release candidates, leave the version number at the development release number corresponding to the `-rc1` candidate.
- Run from the build directory `$ cmake . && make && make version`
1. Tag main ROOT repository
1. Tag and push main ROOT repository
- `git tag -a v6-32-02`
1. Git pull and git tag ROOTTEST repository
1. Make source tar file and copy to ftp area on root.cern
- Run from the build directory `$ make distsrc` _[not on a MacOS machine](https://superuser.com/questions/318809/linux-os-x-tar-incompatibility-tarballs-created-on-os-x-give-errors-when-unt){:target="_blank"}_
- `scp ../root_vX.YY.ZZ.source.tar.gz sftnight@root:/var/www/root/download/`
- `git push upstream v6-32-02`
1. Tag and push ROOTTEST repository
- `git tag -a v6-32-02`
- `git push upstream v6-32-02`
1. Make source tar file and copy onto the download area _[not on a MacOS machine](https://superuser.com/questions/318809/linux-os-x-tar-incompatibility-tarballs-created-on-os-x-give-errors-when-unt){:target="_blank"}_:
- `git clone --depth 1 --branch v6-32-02 https://github.com/root-project/root`
- `mkdir build && cd build && cmake -Dminimal=ON -DCMAKE_BUILD_TYPE="Debug" ../root; make distsrc`
- `scp ../root_vX.YY.ZZ.source.tar.gz usr@srv:/var/www/root/download/`
1. For non-patch releases, create new release notes in `README/ReleaseNotes/vXXX+1/index.md`
- Copy from `README/ReleaseNotes/empty.md`, adjust version numbers.
- `git commit README/ReleaseNotes/vXXX/index.md`
Expand All @@ -95,15 +99,20 @@ This assumes you try to create `v6-32-00-patches`, adjust accordingly.
1. Fix build errors!
- `make` must succeed
- Deprecations will now create build errors, fix them
1. Push to GitHub
- `git push origin v6-32-02`
1. Produce binary tar-files (optional for development releases and release candidates)
- Go to the [`Actions` tab on the root repository page](https://github.com/root-project/root/actions)
- Select the `ROOT CI` workflow
- Click on the `Run workflow button`
- Select the branch for which the release is being made. For example select `v6-32-00-patches` if you are releasing `6.32.16`
- Select for the fields `rebase from` and `... to ...` the tag for the release, e.g. `6.32.16`
- De-select the `Do incremental build` radio button
- Select the `Create binary packages and upload them as artifacts` button
- Select for the `The CMAKE_BUILD_TYPE to use for non-Windows` radio-button the value `Release`
1. Update the stable branch. The command below creates a commit that appears as a merge to git porcelain commands, but that directly points to the tree given by the `LATEST_STABLE` commit-ish. Users that have cloned this branch will receive updates as a fast-forward via `git pull`
- `$ LATEST_STABLE=v6-xx-yy # e.g. v6-32-02`
- `$ git fetch origin latest-stable:latest-stable`
- `$ git fetch upstream latest-stable:latest-stable`
- `$ git update-ref refs/heads/latest-stable $(git commit-tree $LATEST_STABLE^{tree} -p refs/heads/latest-stable -p $LATEST_STABLE^{commit} -m "Updated 'latest-stable' branch to $LATEST_STABLE")`
- `$ git push origin latest-stable`
1. Produce binary tar-files (optional for development releases and release candidates)
- Start the procedure [root-release-6.32](https://lcgapp-services.cern.ch/root-jenkins/job/root-release-6.32/){:target="_blank"} (or whichever branch) in Jenkins
- `$ git push upstream latest-stable`
1. Install binaries to CVMFS (optional for development releases and release candidates)
- Install release binaries to CVMFS with the Jenkins procedure [root-release-CVMFS](https://lcgapp-services.cern.ch/root-jenkins/job/root-release-CVMFS/){:target="_blank"}
1. Create a release page on GitHub, pointing to the release page on the website and the associated release notes, and upload all the relevant artifacts (sources and binaries).
Expand All @@ -120,6 +129,7 @@ This assumes you try to create `v6-32-00-patches`, adjust accordingly.
- Modify the `install/build_from_source.md` file, appending the created file above to the list of build options dropdown items. Look for tags like `<details markdown="1"><summary markdown="span">` and add the file at the end.
- Run `git checkout -b build-options-v632; git add _includes/build_options_v6-32-00-patches.md install/build_from_source.md; git commit; git push` and open a PR on the `web` repository.
1. Announcements
- Example announcement [here](https://root-forum.cern.ch/t/root-v6-26-16-is-out/58606)
- Send mail to the following mailing lists: [email protected], [email protected], [email protected], [email protected]
- Write announcement in RootTalk [forum news](https://root-forum.cern.ch/c/news){:target="_blank"} (optional for development releases and release candidates)
- For new major releases, consider writing a blog post for https://root.cern announcing the highlights.
- For new major releases, consider writing a blog post for https://root.cern announcing the highlights.

0 comments on commit 2923f40

Please sign in to comment.