[jira] [Commented] (FLINK-31153) Create a release branch

["Jing Ge (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-31153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17691315#comment-17691315 ] 

Jing Ge commented on FLINK-31153:
---------------------------------

@mapohl Thanks for creating this task and the umbrella task. It seems those tasks contain more or different information. Are you planning to build a template for the future release?

> Create a release branch
> -----------------------
>
>                 Key: FLINK-31153
>                 URL: https://issues.apache.org/jira/browse/FLINK-31153
>             Project: Flink
>          Issue Type: Sub-task
>            Reporter: Matthias Pohl
>            Priority: Major
>
> If you are doing a new major release, you need to update Flink version in two repositories:
>  * [apache/flink|https://github.com/apache/flink]
>  * [apache/flink-docker|https://github.com/apache/flink-docker]
>  * [apache/flink-benchmarks|https://github.com/apache/flink-benchmarks]
> Minor releases don't require the these repositories to be touched. Simply checkout the already existing branch for that version:
> {code:java}
> $ cd ./tools
> $ git checkout release-$SHORT_RELEASE_VERSION
> {code}
> h4. Flink repository
> Create a branch for the new version that we want to release before updating the master branch to the next development version:
> {code:bash}
> $ cd ./tools
> $ releasing/create_snapshot_branch.sh
> $ git checkout master
> $ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$NEXT_SNAPSHOT_VERSION releasing/update_branch_version.sh
> {code}
> In the {{master}} branch, add a new value (e.g. {{v1_16("1.16")}}) to [apache-flink:flink-annotations/src/main/java/org/apache/flink/FlinkVersion|https://github.com/apache/flink/blob/master/flink-annotations/src/main/java/org/apache/flink/FlinkVersion.java] as the last entry:
> {code:java}
> // ...
> v1_12("1.12"),
> v1_13("1.13"),
> v1_14("1.14"),
> v1_15("1.15"),
> v1_16("1.16");
> {code}
> The newly created branch and updated {{master}} branch need to be pushed to the official repository.
> h4. Flink Docker Repository
> Afterwards fork off from {{dev-master}} a {{dev-x.y}} branch in the [apache/flink-docker|https://github.com/apache/flink-docker] repository. Make sure that [apache/flink-docker:.github/workflows/ci.yml|https://github.com/apache/flink-docker/blob/dev-master/.github/workflows/ci.yml] points to the correct snapshot version; for {{dev-x.y}} it should point to {{{}x.y-SNAPSHOT{}}}, while for {{dev-master}} it should point to the most recent snapshot version (\{[$NEXT_SNAPSHOT_VERSION}}).
> After pushing the new major release branch, as the last step you should also update the documentation workflow to also build the documentation for the new release branch. Check [Managing Documentation|https://cwiki.apache.org/confluence/display/FLINK/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.
>  
> ----
> h3. Expectations (Minor Version only)
>  * Release branch has been created and pushed
>  * Cron job has been added on the release branch in ([apache-flink:./tools/azure-pipelines/build-apache-repo.yml|https://github.com/apache/flink/blob/master/tools/azure-pipelines/build-apache-repo.yml])
>  * Originating branch has the version information updated to the new version
>  * New version is added to the [apache-flink:flink-annotations/src/main/java/org/apache/flink/FlinkVersion|https://github.com/apache/flink/blob/master/flink-annotations/src/main/java/org/apache/flink/FlinkVersion.java] enum.
>  * Make sure {{flink-docker}} has {{dev-x.y}} branch and docker e2e tests run against this branch
>  * docs/config.toml has been updated appropriately.
>  * The {{dev-x.y}} branch of ({{$CURRENT_SNAPSHOT_VERSION}}) have been created in the Flink Benchmark repo.
>  * The {{flink.version}} property of Flink Benchmark repo has been updated to the latest snapshot version.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)