...
If you are doing a new major /minor release, check out the version of the codebase from which you start the release. This may be HEAD
of the master
branch. Create release, create a branch for the new version that we want to release before updating the master branch to the next development version:
Code Block | ||
---|---|---|
| ||
$ git checkout master $ git checkout -b release-$SHORT_RELEASE_VERSION tools $ releasing/create_snapshot_branch.sh tools $ git checkout master $ cd tools tools $ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$NEXT_SNAPSHOT_VERSION releasing/update_branch_version.sh $ cd .. $ git checkout release-$SHORT_RELEASE_VERSION |
If you're creating a new bugfix minor release, you will skip the above step and simply check out the the already existing branch for that version:
...
If this is a major release, the newly created branch needs to be pushed to the official repository.
Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/_config.yml
file:, as listed below.
Code Block | ||
---|---|---|
| ||
version: $RELEASE_VERSION
version_title: $SHORT_RELEASE_VERSION
github_branch: release-$SHORT_RELEASE_VERSION
baseurl: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
javadocs_baseurl: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
pythondocs_baseurl: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
is_stable: true |
After updating the docs configuration and After pushing the new major release branch, as the last step you should also update the documentation build bot to also build the documentation for the new release branch. Check Managing Documentation on details on how to do that. You may also want to manually trigger a build to make the changes visible as soon as possible.
...