Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Script: preparation_before_release.sh
  • Usage 
    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.

...

  • 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 <anonymous@apache.org>
    • sub   2048R/CD4C59FD 2019-08-29

...

  • 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

Access to Apache Nexus 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:


Code Block
<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. If you have problem in submit your GPG key to the key server in browse, please try run


Code Block
gpg --keyserver hkp://pool.sks-keyservers.net --send-keys ${PUBLIC_KEY} and verify via gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys ${PUBLIC_KEY}

...

also

...

send

...

public

...

key

...

to

...

ubuntu

...

server

...

via

...



Code Block
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.

Create a new version in JIRA

...

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

Usage


Code Block
# 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


Checklist to proceed to the next step

...

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. Also, As Hudi is in incubation phase, all artifacts must include “-incubating” in their names

    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}-incubating-rc${RC_NUM}
    3. Run Unit tests  and ensure they succeed
      1. mvn test -DskipITs=true
    4. Run Integration Tests and ensure they succeed
        Run Integration Tests
        1. mvn verify -DskipUTs=true
        and ensure they succeed
      1. Commit and push this change to RELEASE branch
        1. git commit -am “Bumping release candidate number ${RC_NUM}”
        2. git push origin ${RELEASE_BRANCH}
      2. Generate Source Release:
        1. This will create the tarball under hudi/src_release directory
        1. cd hudi/src_release
        2. gpg --verify hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}.src.tgz.asc hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}.src.tgz
          1. You should verify that the signature is good
        3. tar -zxvf hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}.src.tgz && cd hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM} && mvn clean package -DskipTests
        4. If they pass, delete the repository we got from the tar-ball
          1. cd ../ && rm -rf hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}
        1. git checkout ${RELEASE_BRANCH}
        2. Run
          cd scripts && ./release/create_source_release.sh
        3. Verify Source release is signed and buildable
      3. Create tag 
        1. git tag -
          s $
          s ${RELEASE_VERSION}-incubating-rc${RC_NUM} "${RELEASE_VERSION}"
        2. if apache repo is origin.
          1. git push origin ${RELEASE_VERSION}-incubating-rc${RC_NUM}
          if apache repo is origin.
          1.  
      4. 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.
        1. git checkout ${RELEASE_BRANCH}
        2. This will deploy 2.11 artifacts to repository.apache.org
          1. cd scripts && ./release/deploy_staging_jars.sh --scala_version=2.11
          . This 
        3. This will deploy 2.11 12 artifacts to repository.apache.org.
          1. ./release/deploy_staging_jars.sh --scala_version=2.12
          . This will deploy 2.12 artifacts to repository.apache.org.
          1.  
        4. Review all staged artifacts to ensure it contains both 2.11 and 2.12 artifacts, mainly hudi-spark-bundle-2.11/2.12, hudi-spark-2.11/2.12, hudi-utilities-bundle_2.11/2.12 and hudi-utilities_2.11/2.12.
        5. Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Hudi (incubating), version ${RELEASE_VERSION}-incubating, release candidate ${RC_NUM}”.
      5. Stage source releases on dist.apache.org
        1. If you have not already, check out the Hudi section of the dev incubator repository on dist.apache.org via Subversion. In a fresh directoryfresh directory
        2. if you would not checkout, please try svn checkout https://dist.apache.org/repos/dist/dev/incubator/hudi --depth=immediates, if you would not checkout, please try svn checkout  again.
          1. svn checkout https://dist.apache.org/repos/dist/dev/incubator/hudi
           again.
          1.  --depth=immediates
        3. Make a directory for the new release:
          1.  mkdir hudi/hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}
        4. Copy Hudi source distributions, hashes, and GPG signature: 
          1. mv <hudi-dir>/src_release/* hudi/hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}
        5. Add and commit all the files. 
          1. cd hudi 
          2. svn add hudi-${RELEASE_VERSION}-incubating-rc${RC_NUM}
          3. svn commit
        6. Verify that files are present
        7. Run Verification Script to ensure the source release is sane
          1. cd scripts && ./release/validate_staged_release.sh --release=${RELEASE_VERSION} --rc_num=${RC_NUM} --verbose

    Checklist to proceed to the next step

    ...

    From: Release Manager

    To: announce@hudi.apache.org

    Subject: [ANNOUNCE] Apache Hudi (incubating) 0.5.2 released<VERSION> released

     

    The Apache Hudi(incubating) team is pleased to announce the release of Apache

    Hudi incubating 0.5incubating <VERSION>.2.


    Apache Hudi (incubating) (pronounced Hoodie) stands for Hadoop Upserts Deletes

    and Incrementals. Apache Hudi (incubating) manages storage of large analytical

    datasets on DFS (Cloud stores, HDFS or any Hadoop FileSystem compatible storage)

    and provides the ability to query them.


    This release comes xxx months after xxx. It includes more than
    xxx resolved issues, comprising of a few new features as well as
    general improvements and bug-fixes. It includes support for
    xxx, xxx, xxx, and many more bug fixes and improvements.

    You can start using it in Maven by simply updating your dependency to:

    <dependency>
    <groupId>org.apache.hudi</groupId>
    <artifactId>hudi-core</artifactId>
    <version>0.5.2<version><VERSION>-incubating</version>
    </dependency>


    If you'd like to download the source release, you can find it here:

    https://github.com/apache/incubator-hudi/releases/tag/release-0.5.2<VERSION>-incubating

    You can read more about the release (including release notes) here:

    https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322822&version=12346606<JIRA_VERSION>

    We welcome your help and feedback. For more information on how to
    report problems, and to get involved, visit the project website at:

    http://hudi.apache.org/

    Thanks to everyone involved!

    XXX

    ...