Arvados

h1. Release Checklist

Pre-process:

# Create an issue for the release.

# Add each of the following steps (starting at step 1) as tasks with the step number in the subject

# Assign each task

# The current task goes into the "In Progress" column

# When the current task is finished, move it to resolved, and move the next task into "In Progress"

# Notify the assignee of the next task that it is ready to begin

Meta-process:

# Periodically review this documented process reflects our actual process & update it

# When steps are added/changed/rearranged/removed, be use to update the TASKS file used by the Arvados release tool: https://dev.arvados.org/projects/arvados/repository/arvados-dev/revisions/main/show/cmd/art

|_.Step|_.Who|_.What|

|0|engineering|Write lots of great code, build new features|

|1|engineering|Prepare release branch.  For major releases this means branching a new @X.Y-dev@ from main.  For minor releases, this means cherry-picking features onto the existing @X.Y-dev@ branch.|

|2|release eng|Update the "Upgrading Arvados and Release notes" doc page on both @main@ and the @X.Y-dev@ release branch with the version and date of the release.

On the @X.Y-dev@ branch, update these files to refer to the release version instead of @main@: 

@tools/salt-install/provision.sh@

@tools/arvbox/bin/arvbox@

@doc/install/arvbox.html.textile.liquid@|

|3|engineering|Ensure that the release branch passes automated tests on jenkins.  Also review https://dev.arvados.org/projects/arvados/wiki/Manual_testing_plan|

|4|engineering|Review release branch, make sure all commits that need to be in the release are in the release, make sure that dependencies of Python and Ruby packages have upper version pins (to ensure that 3rd party dependencies updated post-stable-release don't break our code)|

|5|product mgr|Create a redmine release for the next patch release beyond this one so that future bugfixes can be assigned to it, if there's a chance that such a release will be made.|

|6|product mgr|Write release notes and publish them to www-dev site: https://www-dev.arvados.org/releases/|

|7|everyone|Review release notes|

|8|release eng|Build release candidate packages with version "X.Y.Z~rcN-1" using the jenkins jobs "build-and-publish-rc-packages":https://ci.arvados.org/view/Release%20Pipeline/job/build-and-publish-rc-packages/ and "workbench2-build-release-candidate-package":https://ci.arvados.org/view/Release%20Pipeline/job/workbench2-build-release-candidate-package/ .  Record the "arvados" and "arvados-workbench2" git commits that were used, as well as links to the jenkins runs on a comment on the release ticket.|

|9|ops|Test installer formula / provision scripts with RC packages - [[Installer development process]] ^1^|

|10|ops|Deploy RC packages to playground ^1^|

|11|bfx|Run "bam-to-vcf pipeline":https://dev.arvados.org/issues/17049#note-7 on playground ^1^|

|12|product mgr|Approve RC for release|

|13|release eng|Build final release packages with version "X.Y.Z-1" using the jenkins jobs "build-and-publish-rc-packages":https://ci.arvados.org/view/Release%20Pipeline/job/build-and-publish-rc-packages/ and "workbench2-build-release-candidate-package":https://ci.arvados.org/view/Release%20Pipeline/job/workbench2-build-release-candidate-package/ .  Record the "arvados" and "arvados-workbench2" git commits that were used, as well as links to the jenkins runs on a comment on the release ticket.|

|14|release eng|Push packages to stable repos using "publish-packages-to-stable-repo":https://ci.arvados.org/view/Release%20Pipeline/job/publish-packages-to-stable-repo/ (see also https://dev.arvados.org/projects/ops/wiki/Promoting_Packages_to_Stable)|

|15|release eng|Publish arvados/jobs docker image using "docker-jobs-image-release":https://ci.arvados.org/view/Release%20Pipeline/job/docker-jobs-image-release/ , Python packages and Ruby gems using "build-publish-packages-python-ruby":https://ci.arvados.org/view/Release%20Pipeline/job/build-publish-packages-python-ruby/ |

|16|release eng|? Publish formula / installer for the release|

|17|release eng|Publish arvados/arvbox-demo docker image using "build-and-release-arvbox-image":https://ci.arvados.org/view/Release%20Pipeline/job/build-and-release-arvbox-image/|

|18|release eng|Tag the commits in each repo used to build the release in git. Please create an annotated tag, with this message: "Release X.Y.Z, release notes at https://arvados.org/release-notes/X.Y.Z/". That will make https://github.com/arvados/arvados/releases look really good.|

|19|release eng|Ensure new release is published on https://doc.arvados.org ; ensure that release notes & any other materials are pointing to correct version of the docs.|

|20|product mgr|Merge release notes (step 6) from "develop" branch to "main" branch of @arvados-www@ git repository and check that https://arvados.org page is updated|

|21|product mgr|"Send out email notifications":https://docs.google.com/spreadsheets/d/18uaUPQ1r2_sQH18JTiblkNFcq8gsFflRAGm8-wvtQi4/edit?usp=sharing , tweet from the Arvados account, announce on the Discourse forum, gitter, etc|

|22|release eng|For major releases: Duplicate the jenkins configuration for the "run-tests" jobs tests to versioned names (run-tests-X.Y) so that future point releases remain testable after @main@ moves on|

^1^ If issues are discovered requiring additional commits, increase the release candidate version by one, and and resume the checklist from step 7.