dimas-b commented on code in PR #3359: URL: https://github.com/apache/polaris/pull/3359#discussion_r2663052940
########## site/content/community/release-guides/tools-manual-release-guide.md: ########## @@ -0,0 +1,335 @@ +--- +# +# 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: Polaris Tools Manual Release Guide +title: Polaris Tools Manual Release Guide +type: docs +weight: 200 +aliases: + - /release-guide + - /community/release-guide +--- + +**Audience**: Release Managers + +This guide walks you through the process of **creating** a release for a Polaris Tool. The guide uses `iceberg-catalog-migrator` as an example. + +## Setup + +To create a release candidate, you will need: + +* your Apache credentials (for repository.apache.org and dist.apache.org repositories) +* a [GPG key](https://www.apache.org/dev/release-signing#generate) for signing artifacts, published in [KEYS](https://downloads.apache.org/incubator/polaris/KEYS) file + +### Publish your GPG key + +If you haven't published your GPG key yet, you must publish it before starting the release process: + +``` +svn checkout https://dist.apache.org/repos/dist/release/incubator/polaris polaris-dist-release +cd polaris-dist-release +echo "" >> KEYS # append a new line +gpg --list-sigs <YOUR KEY ID HERE> >> KEYS # append signatures +gpg --armor --export <YOUR KEY ID HERE> >> KEYS # append public key block +svn commit -m "add key for <YOUR NAME HERE>" +``` + +To send the key to the Ubuntu key-server, Apache Nexus needs it to validate published artifacts: +``` +gpg --keyserver hkps://keyserver.ubuntu.com --send-keys <YOUR KEY ID HERE> +``` + +### Dist repository + +The Apache dist repository (dist.apache.org) is used to populate download.apache.org and archives.apache.org. There are two spaces on dist: + +* `dev` is where you stage the source distribution and other user convenient artifacts (distributions, helm charts, ...) +* `release` is where the artifacts will be copied when the release vote passed + +Apache dist is a svn repository, you need your Apache credentials to commit there. + +### Maven repository + +Apache uses Nexus as Maven repository (repository.apache.org) where releases are staged (during vote) and copied to Maven Central when the release vote passed. + +You have to use Apache credentials on Nexus, configured in `~/.gradle/gradle.properties` file using `mavenUser` and `mavenPassword`: + +``` +apacheUsername=yourApacheId +apachePassword=yourPassword +``` + +Note: an alternative is to use `ORG_GRADLE_PROJECT_apacheUsername` and `ORG_GRADLE_PROJECT_apachePassword` environment variables: + +``` +export ORG_GRADLE_PROJECT_apacheUsername=yourApacheId +export ORG_GRADLE_PROJECT_apachePassword=bar +``` + +### PGP signing + +During release process, the artifacts will be signed with your key, using `gpg-agent`. + +To configure gradle to sign the artifacts, you can add the following settings in your `~/.gradle/gradle.properties` file: + +``` +signing.gnupg.keyName=Your Key Name +``` + +To use `gpg` instead of `gpg2`, also set `signing.gnupg.executable=gpg`. + +For more information, see the Gradle [signing documentation](https://docs.gradle.org/current/userguide/signing_plugin.html#sec:signatory_credentials). + +### GitHub Repository + +The release should be executed against https://github.com/apache/polaris-tools.git repository (not a fork). +Set it as remote with name `apache` for release if it's not already set up. + +## Creating a release candidate + +### Initiate a discussion about the release with the community + +This step can be useful to gather ongoing patches that the community thinks should be in the upcoming Polaris Tool release. + +The communication can be started via a `[DISCUSS]` mail on the [email protected] mailing list and the desired tickets can be added to the github milestone of the next release, specifically on the Polaris Tool you plan to release. + +Note, creating a milestone in github requires a committer. +Also note since Polaris is an incubating project, make sure what every branch / tag you are creating is suffixed with `-incubating`. + +### Create Polaris Tool release branch + +If it's the first RC for the release, you have to create a release branch: + +``` +git branch release/tool/x.y.z +git push apache release/tool/x.y.z +``` + +Go in the branch: + +``` +git checkout release/tool/x.y.z +``` + +Do the needed modifications according to the Polaris Tool (version bump in `version.txt`, ...) and push the changes on the branch. + +### Create release tag + +On the release release branch, you create a tag for the RC: + +``` +git tag apache-polaris-tool-x.y.z-rci Review Comment: I guess, we're going to release each tool (sub-module) individually, right? Does "tool" in the tag/branch names stand for the actual tool name (e.g. `catalog-migrator`)? ########## site/content/community/release-guides/tools-manual-release-guide.md: ########## @@ -0,0 +1,335 @@ +--- +# +# 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: Polaris Tools Manual Release Guide +title: Polaris Tools Manual Release Guide +type: docs +weight: 200 +aliases: + - /release-guide + - /community/release-guide Review Comment: Are these aliases correct? Copy-paste mistake perhaps? 🤔 -- 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]
