-
Notifications
You must be signed in to change notification settings - Fork 429
Release process
- Create release branch
v<major>.<minor>.x
- Bump version of master branch
- Update NEWS on the release branch
- Mention items that affect user experience (feature/bugfix/enhancement), or key infrastructure changes
- Go over commit titles excluding merge commits since the previous release and add relevant items
- NEWS should be updated for every release candidate
git log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr)%Creset' --abbrev-commit --date=relative fork<X-1>commit..branch<X>
- Add items from internal checklists, such as Plan-of-Record
- Tag key community members in the new PR to add/modify missing items
- Author list file is maintained by CI with script
contrib/authors_update.sh
that contains for instance:git log --no-merges --pretty=format:"%an%x09%ae" origin/v1.17.x..origin/v1.18.x | sort -u
https://github.com/openucx/ucx/wiki/UCX-release-checklist
- Go to Code->Releases
- Click Draft new release
- Set the release version, target branch, and mark as pre-release (for release candidate)
-
Click Publish Release
-
An automatic Azure pipeline will start building the packages (https://dev.azure.com/ucfconsort/ucx/_build?definitionId=5&_a=summary), please Do not touch the release page while the job is running. If CI has not been started it maybe needed to re-create tag.
-
When step (5) finishes, there will be a new release page with all packages (21 Assets) attached to it
-
Remove excess news from the release page, tick/untick Pre-release box and click Publish to convert Draft into Pre-release/Latest-release
-
Upload API documentation: (In the commands below replace {version} by 1.12 for example)
- Make a clean checkout of the release branch
- Install the packages doxygen and doxygen-latex. It's recommended to use fedora 30 or above.
./autogen.sh
make docs
git checkout gh-pages
mkdir api/v{version}
-
ln -snf v{version} api/latest
$ ll api lrwxrwxrwx 1 user group 5 Jan 13 14:54 latest -> v1.12`
cp docs/doxygen-doc/ucx.pdf api/v{version}/ucx-v{version}.pdf
ln -s ucx-v{version}.pdf api/v{version}/ucx.pdf
-
cp -ar docs/doxygen-doc/html api/v{version}/
$ ll api/v1.12/ drwxr-xr-x 3 user group 24576 Jan 13 14:38 html -rw-r--r-- 1 user group 1276888 Jan 13 14:45 ucx-v1.12.pdf
git add api/latest api/v{version}
git commit -m "add v{version} documentation"
git push ...
- documentation needs to be rebuilt on readthedocsio
-
Send an email to ucx-dev mailing list to announce the release
-
Bump release version in
configure.ac
anducx.spec.in
(if another minor release is planned on this release branch)
- NEWS file should contain separated section for every drop:
## 1.13.0-rc2 (DATE)
#### Bugfixes
* Bugfix 3
## 1.13.0-rc1 (DATE)
#### Features
* Feature 1
* Feature 2
#### Bugfixes
* Bugfix 1
* Bugfix 2
- GA release drop should cointain single section, which is merge of all release candidates
## 1.13.0 (DATE)
#### Features
* Feature 1
* Feature 2
#### Bugfixes
* Bugfix 1
* Bugfix 2
* Bugfix 3