pan3793 commented on code in PR #30: URL: https://github.com/apache/incubator-celeborn-website/pull/30#discussion_r1445781302
########## docs/community/release_guide.md: ########## @@ -0,0 +1,292 @@ +<!-- +- 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. +--> + +Celeborn Release Guide +==================== + +## Introduction + +The Apache Celeborn (Incubating) project periodically declares and publishes releases. A release is one or more packages +of the project artifact(s) that are approved for general public distribution and use. They may come with various +degrees of caveat regarding their perceived quality and potential for change, such as "alpha", "beta", "incubating", +"stable", etc. + +The Celeborn community treats releases with great importance. They are a public face of the project and most users +interact with the project only through the releases. Releases are signed off by the entire Celeborn community in a +public vote. + +Each release is executed by a Release Manager, who is selected among the Celeborn committers. This document describes +the process that the Release Manager follows to perform a release. Any changes to this process should be discussed +and adopted on the [dev mailing list](mailto:dev@celeborn.apache.org). + +Please remember that publishing software has legal consequences. This guide complements the foundation-wide +[Product Release Policy](https://www.apache.org/dev/release.html) and +[Release Distribution Policy](https://www.apache.org/dev/release-distribution). + +### Overview + +The release process consists of several steps: + +1. Decide to release +2. Prepare for the release +3. Cut branch off for __major__ release +4. Build a release candidate +5. Vote on the release candidate +6. If necessary, fix any issues and go back to step 3. +7. Finalize the release +8. Promote the release +9. Remove the dist repo directories for deprecated release candidates + +## Decide to release + +Deciding to release and selecting a Release Manager is the first step of the release process. This is a consensus-based +decision of the entire community. + +Anybody can propose a release on the [dev mailing list](mailto:dev@celeborn.apache.org), giving a solid argument and +nominating a committer as the Release Manager (including themselves). There’s no formal process, no vote requirements, +and no timing requirements. Any objections should be resolved by consensus before starting the release. + +In general, the community prefers to have a rotating set of 1-2 Release Managers. Keeping a small core set of managers +allows enough people to build expertise in this area and improve processes over time, without Release Managers needing +to re-learn the processes for each release. That said, if you are a committer interested in serving the community in +this way, please reach out to the community on the [dev mailing list](mailto:dev@celeborn.apache.org). + +### Checklist to proceed to the next step + +1. Community agrees to release +2. Community selects a Release Manager + +## Prepare for the release + +Before your first release, you should perform one-time configuration steps. This will set up your security keys for +signing the release and access to various release repositories. + +### One-time setup instructions + +#### ASF authentication + +The environments `ASF_USERNAME` and `ASF_PASSWORD` have been used in several places and several times in the release +process, you can either one-time set up them in `~/.bashrc` or `~/.zshrc`, or export them in terminal every time. + +```shell +export ASF_USERNAME=<your apache username> +export ASF_PASSWORD=<your apache password> +``` + +#### Java Home + +An available environment variable `JAVA_HOME`, you can do `echo $JAVA_HOME` to check it. +Note that, the Java version should be 8. + +#### Subversion + +Besides on `git`, `svn` is also required for Apache release, please refer to +https://www.apache.org/dev/version-control.html#https-svn for details. + +#### GPG Key + +You need to have a GPG key to sign the release artifacts. Please be aware of the ASF-wide +[release signing guidelines](https://www.apache.org/dev/release-signing.html). If you don’t have a GPG key associated +with your Apache account, please create one according to the guidelines. + +Determine your Apache GPG Key and Key ID, as follows: + +```shell +gpg --list-keys --keyid-format SHORT +``` + +This will list your GPG keys. One of these should reflect your Apache account, for example: + +```shell +pub rsa4096/37356FA0 2022-10-27 [SC] [expires: 2028-10-27] + FCF20BB29C7BEFDF58F998F76392F71F37356FA0 +uid [ultimate] Ethan Feng <ethanf...@apache.org> +sub rsa4096/D2ED4CBF 2022-10-27 [E] [expires: 2028-10-27] +``` + +> Note: To follow the [Apache's release specification](https://infra.apache.org/release-signing.html#note), all new RSA keys generated should be at least 4096 bits. Do not generate new DSA keys. + +Here, the key ID is the 8-digit hex string in the pub line: `37356FA0`. + +To export the PGP public key, using: + +```shell +gpg --armor --export 37356FA0 +``` + +If you have more than one gpg key, you can specify the default key as the following: + +``` +echo 'default-key <key-fpr>' > ~/.gnupg/gpg.conf +``` + +The last step is to update the KEYS file with your code signing key +https://www.apache.org/dev/openpgp.html#export-public-key + +```shell +svn checkout --depth=files "https://dist.apache.org/repos/dist/release/incubator/celeborn/"; work/svn-celeborn + +(gpg --list-sigs "${ASF_USERNAME}@apache.org" && gpg --export --armor "${ASF_USERNAME}@apache.org") >> work/svn-celeborn/KEYS + +svn commit --username "${ASF_USERNAME}" --password "${ASF_PASSWORD}" --message "Update KEYS" work/svn-celeborn +``` + +## Cut branch if for major release + +celeborn use version pattern `{MAJOR_VERSION}.{MINOR_VERSION}.{PATCH_VERSION}`, e.g. `0.3.1-incubating`. +__Major Release__ means `MAJOR_VERSION` or `MINOR_VERSION` changed, and __Patch Release__ means `PATCH_VERSION` changed. + +The main step towards preparing a feature release is to create a release branch. This is done via standard Git branching +mechanism and should be announced to the community once the branch is created. + +> Note: If you are releasing a patch version, you can ignore this step. + +The release branch pattern is `branch-{MAJOR_VERSION}.{MINOR_VERSION}`, e.g. `branch-0.3`. + +After cutting release branch, don't forget bump version in `main` branch. + +## Build a release candidate + +> Don't forget to switch to the release branch! + +- Set environment variables. + +```shell +#Do not need to set RELEASE_VERSION manually, the release.sh script has done this. +#RELEASE_VERSION=<release version, e.g. 0.3.1-incubating> Review Comment: ```suggestion # The RELEASE_VERSION will be extracted from the project's root `pom.xml` ``` -- 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: dev-unsubscr...@celeborn.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
