Page History

...

Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/_config.ymltoml file:, as listed below.

version: $RELEASE_VERSION
version_title: $SHORT_RELEASE_VERSION
github_branch: release-$SHORT_RELEASE_VERSION
baseurl: //cibaseURL = '//nightlies.apache.org/projects/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION
javadocs_baseurl: //ci.apache.org/projects/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION
is_stable: true

...

'
IsStable = true
Version = "$RELEASE_VERSION"
VersionTitle = "$SHORT_RELEASE_VERSION"
Branch = "release-$SHORT_RELEASE_VERSION"
MenuLinks = [
    ["Project Homepage", "//flink.apache.org"],
    ["JavaDocs", "//nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION/api/java/"],
  ]

After updating the docs configuration and 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.

For major/minor releases add a link to the release documentation in docs/config.toml in the master branch.

$ git checkout master

PreviousDocs = [
    ["$SHORT_RELEASE_VERSION", "https://nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION"],
    ["2.0", "https://nightlies.apache.org/flink/flink-ml-docs-release-2.0"],
  ]

The rest of this guide assumes that commands are run in the root of a repository on the branch of the release version with the above environment variables set.

...

1. Release Manager’s GPG key is published to dist.apache.org
2. Release Manager’s GPG key is configured in git configuration
3. Release Manager has org.apache.flink listed under Staging Profiles in Nexus
4. Release Manager’s Nexus User Token is configured in settings.xml
5. JIRA release item for the subsequent release has been created
6. There are no release blocking JIRA issues
7. Release Notes in JIRA have been audited and adjusted
8. Release branch has been created and pushed if it is a major release.
9. Originating branch has the version information updated to the new version
10. (major/minor only) Jenkins deployment updated to create snapshot artifacts for release branch (see here)
11. docs/_config.ymltoml has been updated appropriately.
12. The new documentation for major releases is visible under https://ci.apache.org/projects/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION (after at least one doc build finishes).
13. The new documentation for major releases do not contain "-SNAPSHOT" in its version title, and all links refer to the corresponding version docs instead of master.

...

1. Maven artifacts deployed to the staging repository of repository.apache.org
2. Source distribution deployed to the dev repository of dist.apache.org
3. Website pull request proposed to list the release
4. Check docs/_config.ymltoml to ensure that
   • the version constants refer to the new version
   • the baseurl does not point to flink-ml-docs-master  but flink-ml-docs-release-X.Y instead

...