pingtimeout commented on code in PR #3273: URL: https://github.com/apache/polaris/pull/3273#discussion_r2620445154
########## site/content/community/release-guides/semi-automated-release-guide.md: ########## @@ -0,0 +1,336 @@ +--- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +linkTitle: Semi-Automated Release Guide +title: Semi-Automated Release Guide +type: docs +weight: 100 +params: + show_page_toc: true +--- + +**Audience**: Release Managers + +## Overview +The steps performed in the [Manual Release Guide](../manual-release-guide/) have been automated to a large extent. This semi-automated release guide outlines the workflows that can be used to perform a release with little manual intervention. + +## Dry-run mode +Each of the Github Workflows that have been develop comes with a `dry-run` mode. It is enabled ticking the `Dry run mode` checkbox before starting the workflow. When enabled, the workflow will not perform any destructive action (e.g. tag creation, branch deletion, etc.) but instead print out the commands that would have been executed. + +Dry-run mode is enabled by default. So ensure that you uncheck the `Dry run mode` checkbox before starting the workflow. + +## Prerequisites +### Announce the intent to cut a release +Polaris follows a schedule-driven release model. The first thing to do is to send an e-mail to the [email protected] mailing list to announce the intent to cut a release, approximately a week before the scheduled release date. The e-mail should include the following information: +* The version number of the release (e.g. 1.4.0) +* The tentative date of the release (e.g. 2026-01-19) + +Note that the tentative date is only a suggestion. The actual date of the release will be determined by taking community feedback into account. For instance, if specific pull requests are about to be merged, the release may be delayed by a couple of days to include them. + +``` +[DISCUSS] Apache Polaris x.y.z +``` + +``` +Hello everyone, + +The purpose of this e-mail is to collect feedback on the upcoming Apache +Polaris x.y.z release. The tentative release date is YYYY-MM-DD. Please let +me know if you have any concerns or comments, or if there are some specific +pull requests that you would like to see included in the release. + +Thanks, +``` + +### Ensure that the changelog is up to date +As part of Polaris development process, for each major change in the codebase, a new entry should be added to the `CHANGELOG.md` file. This is usually verified during pull request reviews. But some changes may have been missed. So before cutting a release, it is important to ensure that the changelog is up to date. + +## Release branch creation workflow +The first Github workflow to run is [`Release - 1 - Create Release Branch`](https://github.com/apache/polaris/actions/workflows/release-1-create-release-branch.yml). This workflow will create a release branch from the main branch. The release branch is named after the release number and does not include the patch version. For instance, the release branch for version 1.3.0 is named `release/1.3.x`. It should **only be executed only once** per `major.minor` version. Review Comment: There were a lot of double-spaces here and there so I fixed them all, sorry about that, I use them a lot. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
