vinishjail97 commented on code in PR #434: URL: https://github.com/apache/incubator-xtable/pull/434#discussion_r1673720668
########## release/release_guide.md: ########## @@ -0,0 +1,570 @@ +<!-- + 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 + +Apache XTable, currently an incubating project at the Apache Software Foundation (ASF), is a cross-table converter for table formats that facilitates omni-directional interoperability across data processing systems and query engines. +This guide outlines the steps for releasing Apache XTable versions, following the ASF policies and incorporating practices from other successful ASF projects. + +# Legal Reminders + +Releasing software under the ASF banner requires adherence to the [ASF Release Policy](https://infra.apache.org/release-publishing.html) and [Incubator Release Guidelines](https://incubator.apache.org/guides/releasemanagement.html#best-practice). +Please ensure all releases comply with these guidelines, focusing on proper licensing, source code distribution, and community approval. + +# 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 + +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 ./incubator-xtable/release/scripts/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 incubator-xtable’s KEYS file both + in [dev](https://dist.apache.org/repos/dist/dev/incubator/xtable/KEYS) + and [release](https://dist.apache.org/repos/dist/release/incubator/xtable/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 XXXXXXXX + - 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.xtable 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 release branch in apache/incubator-xtable repository + +Attention: Only committer has permission to create release branch in apache/incubator-xtable. +**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-xtable/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 +./incubator-xtable/release/scripts/cut_release_branch.sh -h +``` + +## 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/incubator-xtable + +```shell +mvn -Prelease clean install +``` + +## 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.xtable 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 incubator-xtable/src_release directory + 1. git checkout ${RELEASE_BRANCH} + 2. cd scripts && ./release/create_source_release.sh Review Comment: This file needs to be added `create_source_release.sh` -- 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]
