-
Notifications
You must be signed in to change notification settings - Fork 423
Release process
Yossi Itigin edited this page Jan 13, 2022
·
17 revisions
- 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 master..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
- Update Author list before release
git log --pretty=format:"%an%x09%ae" | sort | uniq > AUTHORS.new
- since people use multiple email addresses and names we have to clean up the new file
vimdiff AUTHORS.new AUTHORS
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, please Do not touch the release page while the job is running
-
When step (5) finishes, there will be a new release page with all packages attached to it
-
Remove excess news from the release page
-
Upload API documentation:
- make a clean checkout of the release branch
- install doxygen and texlive packages
- ./autogen.sh
- ./configure --with-docs-only
- make docs
- checkout gh-pages branch
- mkdir api/ucx-v{version} # for example, 'mkdir ucx-v1.12'
- 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 v{version}/ucx-v{version}.pdf
- cp -ar docs/doxygen-doc/html 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/ucx-v{version}
- git commit -m "add v{version} documentation"
- git push
-
Send an email to ucx-dev mailing list to announce the release