From da444462f1a93735a8a080cbd8771ce35dba273e Mon Sep 17 00:00:00 2001 From: Piotr Konopka Date: Mon, 2 Jun 2025 09:40:34 +0200 Subject: [PATCH] update release procedure - delete obsolete, add patch release --- docs/development.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/development.md b/docs/development.md index d0373f09..20247acc 100644 --- a/docs/development.md +++ b/docs/development.md @@ -8,11 +8,26 @@ Bugs go to [JIRA](https://its.cern.ch/jira/projects/OCTRL/issues). ## Release Procedure +### Major releases + 1. Update documentation if necessary. 2. Bump `VERSION` file, commit, push (or pull request). -3. Run `hacking/release_notes.sh HEAD` to get a formatted commit message list since the last tag, copy it. -4. Paste the above into a [new GitHub release draft](https://github.com/AliceO2Group/Control/releases/new). Sort, categorize, add summary on top. -5. Pick a version number. Numbers `x.x.80`-`x.x.89` are reserved for Alpha pre-releases. Numbers `x.x.90`-`x.x.99` are reserved for Beta and RC pre-releases. If doing a pre-release, don't forget to tick `This is a pre-release`. When ready, hit `Publish release`. -6. Go to your local clone of `alidist`, ensure that the branch is `master` and that it's up to date. Then branch out into `aliecs-bump` (`git branch aliecs-bump`). -7. Bump the version in `control.sh`, `control-core.sh`, `control-occplugin.sh` and `coconut.sh`. Commit and push to `origin/aliecs-bump` (`git push -u origin aliecs-bump`). -8. Submit pull request with the above to `alisw/alidist`. +3. Go to a [new GitHub release draft](https://github.com/AliceO2Group/Control/releases/new). Use "Generate release notes" to create a list of changes. Write a short summary at the top. +4. Go to your local clone of `alidist`, ensure that the branch is `master` and that it's up to date. Then branch out into `aliecs-bump` (`git branch aliecs-bump`). +5. Bump the version in `control.sh`, `control-core.sh`, `control-occplugin.sh` and `coconut.sh`. Commit and push to `origin/aliecs-bump` (`git push -u origin aliecs-bump`). +6. Submit pull request with the above to `alisw/alidist`. + +### Patch releases + +1. Update documentation if necessary. +2. If the patch release should NOT be based on master: + + * Checkout the tag which the patch release should be based on, e.g. `git checkout v1.34.0` + * Create a branch called `branch_`, e.g. `git checkout -b branch_v1.34.1`. + +3. Bump `VERSION` file, commit, push (or pull request). +4. Go to a [new GitHub release draft](https://github.com/AliceO2Group/Control/releases/new). Use "Generate release notes" to create a list of changes. Write a short summary at the top. +5. Go to your local clone of `alidist`, ensure that the branch is `master` and that it's up to date. Then branch out into `aliecs-bump` (`git branch aliecs-bump`). +6. Bump the version in `control.sh`, `control-core.sh`, `control-occplugin.sh` and `coconut.sh`. Commit and push to `origin/aliecs-bump` (`git push -u origin aliecs-bump`). +7. Submit pull request with the above to `alisw/alidist`. +