nsivabalan commented on code in PR #7212: URL: https://github.com/apache/hudi/pull/7212#discussion_r1030772819
########## release/release_guide.md: ########## @@ -0,0 +1,678 @@ +<!-- + 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. +--> + +# Introduction + +This release process document is based on [Apache Beam Release Guide](https://beam.apache.org/contribute/release-guide/) +and [Apache Flink Release Guide](https://cwiki.apache.org/confluence/display/FLINK/Creating+a+Flink+Release). + +The Apache Hudi 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”, “stable”, etc. + +Hudi 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 Hudi community in a public vote. + +Each release is executed by a Release Manager, who is selected among the Hudi PMC members. 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. + +Please remember that publishing software has legal consequences. This guide complements the +foundation-wide [Product Release Policy](http://www.apache.org/dev/release.html) +and [Release Distribution Policy](http://www.apache.org/dev/release-distribution). + +# Overview + + + +The release process consists of several steps: + +1. Decide to release +2. Prepare for the release +3. Build a release candidate +4. Vote on the release candidate +5. During vote process, run validation tests +6. If necessary, fix any issues and go back to step 3. +7. Finalize the release +8. Promote the release + +# 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, 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 3-5 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. + +## Checklist to proceed to the next step + +1. Community agrees to release +2. Community selects a Release Manager + +# Prepare for the release + +As a release manager, you should create a private Slack channel, named `hudi-<version>_release_work` (e.g. +hudi-0_12_0_release_work) in Apache Hudi Slack for coordination. Invite all committers to the channel. + +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. + +To prepare for each release, you should audit the project status in the JIRA issue tracker, and do the necessary +bookkeeping. Finally, you should create a release branch from which individual release candidates will be built. + +**NOTE**: If you are +using [GitHub two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/) +and haven’t configure HTTPS access, please +follow [the guide](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) to configure +command line access. + +## One-time Setup Instructions + +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 follow the section below. + +### For Linux users + +There are 2 ways to configure your GPG key for release, either using release automation script(which is recommended), or +running all commands manually. If using Mac, please see below to handle known issues. + +#### Use preparation_before_release.sh to setup GPG + +- Script: preparation_before_release.sh +- Usage ./hudi/scripts/release/preparation_before_release.sh +- Tasks included + 1. Help you create a new GPG key if you want. + 2. Configure git user.signingkey with chosen pubkey. + 3. Add chosen pubkey into dev KEYS and release KEYS **NOTES**: Only PMC can write into release repo. + 4. Start GPG agents. + +#### Run all commands manually + +- Get more entropy for creating a GPG key + - sudo apt-get install rng-tools + - sudo rngd -r /dev/urandom +- Create a GPG key + - gpg --full-generate-key +- Determine your Apache GPG Key and Key ID, as follows: + - gpg --list-keys +- This will list your GPG keys. One of these should reflect your Apache account, for example: + ``` + -------------------------------------------------- + pub 2048R/935D191 2019-08-29 + uid Anonymous Anonymous <[email protected]> + sub 2048R/CD4C59FD 2019-08-29 + ``` + Here, the key ID is the 8-digit hex string in the pub line: 845E6689 or more than 8-digit hex string like + 623E08E06DB376684FB9599A3F5953147903948A. Now, add your Apache GPG key to the Hudi’s KEYS file both + in [dev](https://dist.apache.org/repos/dist/dev/hudi/KEYS) + and [release](https://dist.apache.org/repos/dist/release/hudi/KEYS) repositories + at [dist.apache.org](http://dist.apache.org/). Follow the instructions listed at the top of these files. (**Note**: + Only PMC members have write access to the release repository. If you end up getting 403 errors ask on the mailing list + for assistance.) +- Configure git to use this key when signing code by giving it your key ID, as follows: + - git config --global user.signingkey CD4C59FD, or git config --global user.signingkey + 623E08E06DB376684FB9599A3F5953147903948A + - You may drop the --global option if you’d prefer to use this key for the current repository only. +- Start GPG agent in order to unlock your GPG key + - eval $(gpg-agent --daemon --no-grab --write-env-file $HOME/.gpg-agent-info) + - export GPG_TTY=$(tty) + - export GPG_AGENT_INFO + +### For Mac users + +- apt-get is not available. So install gpg using [https://gpgtools.org/](https://gpgtools.org/). +- Create gpg key with your apache emailId and publish to key server (referhttps://gpgtools.org/ to the section "Submit + your GPG public key into MIT PGP Public Key Server" below) +- The KEYS file is in [https://dist.apache.org/repos/dist/](https://dist.apache.org/repos/dist/) + - To checkout you need subversion. If subversion is not available in Mac you might have to first install it + using `brew install subversion`. + +### Access to Apache Nexus repository + +Configure access to the Apache Nexus repository, which enables final deployment of releases to the Maven Central +Repository. + +1. You log in with your Apache account. +2. Confirm you have appropriate access by finding org.apache.hudi under Staging Profiles. +3. Navigate to your Profile (top right dropdown menu of the page). +4. Choose User Token from the dropdown, then click Access User Token. Copy a snippet of the Maven XML configuration + block. +5. Insert this snippet twice into your global Maven settings.xml file, typically ${HOME}/.m2/settings.xml. The end + result should look like this, where TOKEN_NAME and TOKEN_PASSWORD are your secret tokens: + +```xml +<settings> + <servers> + <server> + <id>apache.releases.https</id> + <username>TOKEN_NAME</username> + <password>TOKEN_PASSWORD</password> + </server> + <server> + <id>apache.snapshots.https</id> + <username>TOKEN_NAME</username> + <password>TOKEN_PASSWORD</password> + </server> + </servers> + </settings> +``` + +### Submit your GPG public key into MIT PGP Public Key Server + +In order to make yourself have the right permission to stage java artifacts in Apache Nexus staging repository, please +submit your GPG public key into [MIT PGP Public Key Server](http://pgp.mit.edu:11371/). + +Also send public key to ubuntu server via + +```shell +gpg --keyserver hkp://keyserver.ubuntu.com --send-keys ${PUBLIC_KEY} # send public key to ubuntu server +gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys ${PUBLIC_KEY} # verify +``` + +would also refer +to [stackoverflow](https://stackoverflow.com/questions/19462617/no-public-key-key-with-id-xxxxx-was-not-able-to-be-located-oss-sonatype-org) +. + +## Create a new version in JIRA + +When contributors resolve an issue in JIRA, they are tagging it with a release that will contain their changes. With the +release currently underway, new issues should be resolved against a subsequent future release. Therefore, you should +create a release item for this subsequent release, as follows: + +**Attention**: Only PMC has permission to perform this. If you are not a PMC, please ask for help in dev@ mailing list. + +In [JIRA](https://jira.apache.org/jira/projects/HUDI/summary), navigate +to [Hudi > Administration > Versions](https://issues.apache.org/jira/plugins/servlet/project-config/HUDI/versions). Add +a new release. Choose the next minor version number after the version currently underway, select the release cut date ( +today’s date) as the Start Date, and choose Add. At the end of the release, go to the same page and mark the recently +released version as released. Use the ... menu and choose Release. + +## Triage release-blocking issues in JIRA + +There could be outstanding release-blocking issues, which should be triaged before proceeding to build a release +candidate. We track them by assigning a specific Fix version field even before the issue resolved. + +The list of release-blocking issues is available at +the [version status page](https://issues.apache.org/jira/projects/HUDI?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased-archived). +Triage each unresolved issue with one of the following resolutions: + +For all JIRA issues: +- If the issue has been resolved and JIRA was not updated, resolve it accordingly. + +For JIRA issues with type “Bug” or labeled “flaky”: +- If the issue is a known continuously failing test, it is not acceptable to defer this until the next release. Please +work with the Hudi community to resolve the issue. +- If the issue is a known flaky test, make an attempt to delegate a fix. However, if the issue may take too long to fix (to the discretion of the release manager): + - Delegate manual testing of the flaky issue to ensure no release blocking issues. + - Update the Fix Version field to the version of the next release. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate. + +For all other JIRA issues: +- If the issue has not been resolved and it is acceptable to defer this until the next release, update the Fix Version field to the new version you just created. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate. +- If the issue has not been resolved and it is not acceptable to release until it is fixed, the release cannot proceed. Instead, work with the Hudi community to resolve the issue. + +If there is a bug found in the RC creation process/tools, those issues should be considered high priority and fixed in 7 days. + +## Review Release Notes in JIRA + +JIRA automatically generates Release Notes based on the Fix Version field applied to issues. Release Notes are intended for Hudi users (not Hudi committers/contributors). You should ensure that Release Notes are informative and useful. + +Open the release notes from the [version status page](https://issues.apache.org/jira/browse/Hudi/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel) by choosing the release underway and clicking Release Notes. + +You should verify that the issues listed automatically by JIRA are appropriate to appear in the Release Notes. Specifically, issues should: + +- Be appropriately classified as Bug, New Feature, Improvement, etc. +- Represent noteworthy user-facing changes, such as new functionality, backward-incompatible API changes, or performance improvements. +- Have occurred since the previous release; an issue that was introduced and fixed between releases should not appear in the Release Notes. +- Have an issue title that makes sense when read on its own. + +## Create a release branch in apache/hudi repository + +Attention: Only committer has permission to create release branch in apache/hudi. +**Skip this step if it is a bug fix release. But do set the env variables.** + +Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the Apache code repository, and update version information on the original branch. + +Export Some Environment variables in the terminal where you are running the release scripts + +- export RELEASE_VERSION=<RELEASE_VERSION_TO_BE_PUBLISHED> +- export NEXT_VERSION=<NEW_VERSION_IN_MASTER> +- export RELEASE_BRANCH=release-<RELEASE_VERSION_TO_BE_PUBLISHED> +- export RC_NUM=<release_candidate_num_starting_from_1> + +Use cut_release_branch.sh to cut a release branch + +- Script: [cut_release_branch.sh](https://github.com/apache/incubator-hudi/blob/master/scripts/release/cut_release_branch.sh) + +Usage + +```shell +# Cut a release branch +Cd scripts && ./release/cut_release_branch.sh \ +--release=${RELEASE_VERSION} \ +--next_release=${NEXT_VERSION} \ +--rc_num=${RC_NUM} +# Show help page +./hudi/scripts/release/cut_release_branch.sh -h +``` + +## For Bug Fix release: + +Here is how to go about a bug fix release. + +- Create a branch in your repo (<user>/hudi). +- Cherry-pick commits from master that needs to be part of this release. (git cherry-pick commit-hash). You need to manually resolve the conflicts. For eg, a file might have been moved to a diff class in master where as in your release branch, it could be in older place. You need to take a call where to place it. Similar things like file addition, file deletion, etc. +- Update the release version by running "mvn versions:set -DnewVersion=${RELEASE}-rc${RC_NUM}", with "RELEASE" as the version and "RC_NUM" as the RC number. Make sure the version changes are intended. Then git commit the changes. +- Ensure both compilation and tests are good. +- I assume you will have apache/hudi as upstream. If not add it as upstream +- Once the branch is ready with all commits, go ahead and push your branch to upstream. +- Go to apache/hudi repo locally and pull this branch. Here after you can work on this branch and push to origin when need be. +- Do not forget to set the env variables from above section. + +## Verify that a Release Build Works + +Run "mvn -Prelease clean install" to ensure that the build processes are in good shape. // You need to execute this command once you have the release branch in apache/hudi + +Good to run this for all profiles + +```shell +mvn -Prelease clean install +mvn -Prelease clean install -Dscala-2.12 +mvn -Prelease clean install -Dspark3 +``` + +## Checklist to proceed to the next step + +- Release Manager’s GPG key is published to [dist.apache.org](http://dist.apache.org/). +- Release Manager’s GPG key is configured in git configuration. +- Release Manager has org.apache.hudi listed under Staging Profiles in Nexus. +- Release Manager’s Nexus User Token is configured in settings.xml. +- JIRA release item for the subsequent release has been created. +- All test failures from branch verification have associated JIRA issues. +- There are no release blocking JIRA issues. +- Release branch has been created. +- Release Notes have been audited and added to RELEASE_NOTES.md. + +# Build a release candidate + +The core of the release process is the build-vote-fix cycle. Each cycle produces one release candidate. The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized. + +Set up a few environment variables to simplify Maven commands that follow. This identifies the release candidate being built. Start with RC_NUM equal to 1 and increment it for each candidate. + +1. git checkout ${RELEASE_BRANCH} +2. Run mvn version to set the proper rc number in all artifacts + 1. mvn versions:set -DnewVersion=${RELEASE_VERSION}-rc${RC_NUM} +3. Run Unit tests and ensure they succeed + 1. mvn test -DskipITs=true +4. Run Integration Tests and ensure they succeed + 1. mvn verify -DskipUTs=true +5. Commit and push this change to RELEASE branch + 1. git commit -am "Bumping release candidate number ${RC_NUM}" + > There will be some backup files created which needs to be removed. + > + > You could do "git clean -fd" before doing the commit. + 2. git push origin ${RELEASE_BRANCH} + > If you already have a remote tag with same name as your branch, you can try below command. + > + > git push origin refs/heads/${RELEASE_BRANCH} + > + > "refs/heads/" refers to a branch. + > + > "refs/tags/" refers to tag. +6. Generate Source Release: This will create the tarball under hudi/src_release directory + 1. git checkout ${RELEASE_BRANCH} + 2. cd scripts && ./release/create_source_release.sh + > If you have multiple gpg keys(gpg --list-keys), then the signing command will take in the first key most likely. + > You will release this when it asks for a passphrase in a pop up. + > When asked for passphrase, ensure the intended key is the one asked for. + > + > Command used in script: + > + > gpg --armor --detach-sig ${RELEASE_DIR}/hudi-${RELEASE_VERSION}.src.tgz + > + > To use a specific key: update as follows: // replace FINGERPRINT + > + > gpg --local-user [FINGERPRINT] --armor --detach-sig ${RELEASE_DIR}/hudi-${RELEASE_VERSION}.src.tgz + 3. Verify Source release is signed and buildable + 1. cd hudi/src_release + 2. gpg --verify hudi-${RELEASE_VERSION}-rc${RC_NUM}.src.tgz.asc hudi-${RELEASE_VERSION}-rc${RC_NUM}.src.tgz + 3. tar -zxvf hudi-${RELEASE_VERSION}-rc${RC_NUM}.src.tgz && cd hudi-${RELEASE_VERSION}-rc${RC_NUM} && mvn clean package -DskipTests -Pintegration-tests + 4. If they pass, delete the repository we got from the tar-ball + - cd ../ && rm -rf hudi-${RELEASE_VERSION}-rc${RC_NUM} + +7. Create tag + 1. git tag -s release-${RELEASE_VERSION}-rc${RC_NUM} -m "${RELEASE_VERSION}". + > If you run into some issues, and if want to re-run the same candidate again from start, ensure you delete existing tags before retrying again. + > + > // to remove local + > + > git tag -d release-${RELEASE_VERSION}-rc${RC_NUM} + > + > // to remove remote + > + > git push --delete origin release-${RELEASE_VERSION}-rc${RC_NUM} + 2. if apache repo is origin. + > git push origin release-${RELEASE_VERSION}-rc${RC_NUM} + > + > If a branch with the same name already exists in origin, this command might fail as below. + > + > error: src refspec release-0.5.3 matches more than one + > + > error: failed to push some refs to 'https://github.com/apache/hudi.git' + > + > In such a case, try below command + > + > git push origin refs/tags/release-${RELEASE_VERSION}-rc${RC_NUM} + +8. [Stage source releases](https://www.apache.org/legal/release-policy.html#stage) on [dist.apache.org](http://dist.apache.org/) + 1. If you have not already, check out the Hudi section of the dev repository on [dist.apache.org](http://dist.apache.org/) via Subversion. In a fresh directory + 2. if you would not checkout, please try svn checkout [https://dist.apache.org/repos/dist/dev/hudi](https://dist.apache.org/repos/dist/dev/hudi) again. + 1. svn checkout [https://dist.apache.org/repos/dist/dev/hudi](https://dist.apache.org/repos/dist/dev/hudi) --depth=immediates + 3. Make a directory for the new release: + 1. mkdir hudi/hudi-${RELEASE_VERSION}-rc${RC_NUM} + 4. Copy Hudi source distributions, hashes, and GPG signature: + 1. mv <hudi-dir>/src_release/* hudi/hudi-${RELEASE_VERSION}-rc${RC_NUM} + 5. Add and commit all the files. + 1. cd hudi + 2. svn add hudi-${RELEASE_VERSION}-rc${RC_NUM} + 3. svn commit + 6. Verify that files are [present](https://dist.apache.org/repos/dist/dev/hudi) + 7. Run Verification Script to ensure the source release is sane + 1. For RC: cd scripts && ./release/validate_staged_release.sh --release=${RELEASE_VERSION} --rc_num=${RC_NUM} --verbose + 2. For finalized release in dev: cd scripts && ./release/validate_staged_release.sh --release=${RELEASE_VERSION} --verbose + +9. Deploy maven artifacts and verify + 1. This will deploy jar artifacts to the Apache Nexus Repository, which is the staging area for deploying jars to Maven Central. + 2. Review all staged artifacts (https://repository.apache.org/). They should contain all relevant parts for each module, including pom.xml, jar, test jar, source, test source, javadoc, etc. Carefully review any new artifacts. + 3. git checkout ${RELEASE_BRANCH} + 4. ./scripts/release/deploy_staging_jars.sh 2>&1 | tee -a "/tmp/${RELEASE_VERSION}-${RC_NUM}.deploy.log" + 1. when prompted for the passphrase, if you have multiple gpg keys in your keyring, make sure that you enter the right passphase corresponding to the same key (FINGERPRINT) as used while generating source release in step f.ii. + > If the prompt is not for the same key (by default the maven-gpg-plugin will pick up the first key in your keyring so that could be different), then add the following option to your ~/.gnupg/gpg.conf file + 2. make sure your IP is not changing while uploading, otherwise it creates a different staging repo + 3. Use a VPN if you can't prevent your IP from switching + 4. after uploading, inspect the log to make sure all maven tasks said "BUILD SUCCESS" + 5. Review all staged artifacts by logging into Apache Nexus and clicking on "Staging Repositories" link on left pane. Then find a "open" entry for apachehudi + 6. Ensure it contains all 3 (2.11, 2.12 with spark2 and 2.12 with spark3) artifacts, mainly hudi-spark-bundle-2.11/2.12, hudi-spark3-bundle-2.12, hudi-spark-2.11/2.12, hudi-spark2-2.11/2.12, hudi-spark3-2.12, hudi-utilities-bundle_2.11/2.12 and hudi-utilities_2.11/2.12. + > With 0.10.1, we had 4 bundles. spark2 with scala11, spark2 with scala12, spark3.0.x bundles and spark3.1.x bundles. Ensure each spark bundle reflects the version correctly. hudi-spark3.1.2-bundle_2.12-0.10.1.jar and hudi-spark3.0.3-bundle_2.12-0.10.1.jar are the respective bundle names for spark3 bundles. + 7. Once you have ensured everything is good and validation of step 7 succeeds, you can close the staging repo. Until you close, you can re-run deploying to staging multiple times. But once closed, it will create a new staging repo. So ensure you close this, so that the next RC (if need be) is on a new repo. So, once everything is good, close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Hudi, version ${RELEASE_VERSION}, release candidate ${RC_NUM}”. Review Comment: did you get a chance to fix this -- 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]
