Versions Compared

Key

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

...

  1. Check for the most recent develop SHA that passes all the tests and contains all the features / bug fixes that need to go into the release at https://concourse.apachegeode-ci.info/beta/teams/main/pipelines/develop/jobs/UpdatePassingRef.
  2. Ensure in JIRA, that all tickets with {version} as the fix version are either closed or resolved. If not inform the the assignees to either resolve/close it or if not fixed then increment the fix version in the ticket
  3. Create the release branch.

    Code Block
    titleCreate release branch
    git checkout -b release/{version}


  4. gradle.properties

      1. remove -SNAPSHOT in releaseType 
  5. docker/Dockerfile
      1. Update GEODE_GPG with your GPG fingerprint.
      2. Update GEODE_VERSION with the release version (eg. 1.8.0)
  6. Update the version number in all the expected pom files. Doing it manually takes a lot of time. If you choose to do it I have listed the files below. Otherwise please use the script below to do it.

    Info
    titleUpdating the expected-pom files

    - build geode after the version is updated in gradle.properties. NOTE: The build will fail but will have the correct expected-pom.xml files

    Code Block
    languagebash
    titlegradle build
    ./gradlew clean build -Dskip.tests=true

    - Update dependency versions using gradle task updateExpectedPom.

    Code Block
    languagebash
    titlegradle uEP
    ./gradlew uEP

    - Publish the release branch to origin

    Code Block
    titlePublish the release branch
    git add .
    git commit -a -m "Upgraded version number for releasing {version}"
    pit push origin release/{version}



  7. Send email to dev@geode.apache.org informing the creation of the release branch and requesting feedback.

    No Format
    Hello Geode Dev Community,
    
    
    We have created a new release branch for Apache Geode {version} - "release/{version}"
    
    Please do review and raise any concern with the release branch.
    If no concerns are raised, we will start with the voting for the release candidate soon.
    
    
    Regards
    {Release Manager}



  8. Setting up concourse release pipeline

    a. You can deploy a

    release

    pipeline by deploying a meta

    pipeline

    . Run

    No Format
    Hello Geode Dev Community,
    $ cd ci/pipelines/meta
    $ ./deploy_meta.sh
    
    # You might need fly in your PATH 
    # fly target named `concourse.apachegeode-ci.info`
    $ fly -t concourse.apachegeode-ci.info login --concourse-url https://concourse.apachegeode-ci.info/

    b. Send a email to dev@geode.apache.org requesting creation of a CI pipeline

    noformat
    Hello Geode Dev Community,
    
    
    As we have created a release branch for Apache Geode {version} - "release/{version}"
    please create a CI pipeline for running tests on this branch.
    
    
    Regards
    {


Release

...

Release Doc preparation:

  1. Start preparing the release docs at Release Notes. Use information from all the JIRAs that were closed or resolved. 
  2. Also write up a short paragraph on what was added to the release. This will need to go with the final announce email. Sample:


    No Format
    Geode 1.7.0 contains a number of improvements and bug fixes. It includes performance improvements in OQL order-by and distinct queries in client/server when security is enabled. New GFSH commands were added to get/set cluster config and to destroy gateway receivers. A new post processor was added to the new client protocol. Pulse now supports legacy SSL options. Auto-reconnecting members no more reuse old addresses and IDs. Duplicated or member-specific receivers are removed from cluster config during rolling upgrades. Users are encouraged to upgrade to the latest release.



...

  1. Checkout the release branch.


  2. If you are using GPG Tools >= 2.1, export your secret key to a file to be used by Gradle. You can export it with `gpg --export-secret-keys >~/.gnupg/secring.gpg`
             
  3. Log in to repository.apache.org and select staging repositories. Find "orgapachegeode-####" and clink on "Drop"
  4. Clean and build the artifacts. Run this command on a machine using GUI as you will be prompted to enter PGP and ASF LDAP password (Apache password). You will see messages like "Could not find metadata org.apache.geode:geode-cq/maven-metadata.xml" on your terminal. Ignore them.

    Code Block
    languagebash
    git clean -fdx && ./gradlew clean build publish -Paskpass -Psigning.keyId=last_8_characters_of_your_gpg_fingerprint -Psigning.secretKeyRingFile=/Users/yourusername/.gnupg/secring.gpg
    mavenUsername=your_apache_ldap_username


  5. Copy release artifacts to ASF dist repo. DO NOT DELETE THE FOLDERS CREATED IN THIS STEP - THEY ARE NEEDED FOR THE FINAL RELEASE.

    Code Block
    languagebash
    #create a new empty directory
    
    
    svn checkout https://dist.apache.org/repos/dist --depth empty
    svn update --set-depth infinity --parents dist/dev/geode
    svn update --set-depth infinity --parents dist/release/geode
     
    cd dist/dev/geode
    
    
    # copy the KEYS file from the apache-geode release branch folder in your system.
    cp ${GEODE_SRC}/KEYS .
    svn commit -m "Updating Apache Geode KEYS file"
     
    mkdir {version}.RC#
    cp ${GEODE_SRC}/geode-assembly/build/distributions/* {version}.RC#
     
    svn add {version}.RC#
    svn commit -m "Releasing Apache Geode {version}.RC# distribution"


  6. Verify that all the artifacts have been uploaded to the nexus repository by logging into repository.apache.org and then click on close. Example:
  7. In the release branch folder tag the commit. All Release Candidates start with the number 1 eg. RC1. Be careful as rel/ folder is protected, once we push the release tag to server, it cannot be modified. Any other change will have to be moved to the next RC number.

    Code Block
    languagebash
    git config user.email "email_address_associated_with_your_gpg_key"
    git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0"
    git push origin rel/v{version}.RC#


  8. Now checkout the repo for geode-examples and create a release branch.

    Code Block
    titleCreate release branch
    git checkout develop
    git checkout -b release/{version}


  9. Update the version number in gradle.properties of geode-examples

    Code Block
    version = 1.7.0
    geodeVersion = 1.7.0


  10. Commit the version changes and push the release branch of geode-examples


    Code Block
    git add -p
    git commit
    git push origin HEAD


  11. check that gfsh is not on your path already

    Code Block
    $ gfsh
    -bash: gfsh: command not found


  12. In the geode-examples folder, build and run it with the apache-geode version that was uploaded to the ASF dist repo.

    Code Block
    # first build the release artifacts, specifying the RC release location and staging repository
    git clean -dxf && ./gradlew -PsignArchives -PgeodeReleaseUrl=https://dist.apache.org/repos/dist/dev/geode/{version}.RC# -PgeodeRepositoryUrl=https://repository.apache.org/content/repositories/orgapachegeode-{NNNN} build runAll
     
    #if all tests pass then continue ahead, else kindly fix the issues


  13. If there are no failures, then upload the artifacts to ASF dist repo using the folder created in step 65

    Code Block
    # then upload the release artifacts for distribution
    # go to the folder created in step 6 and copy the geode-example artifacts to it
    cd dist/dev/geode
    cp ${GEODE_EXAMPLES_SRC}/build/distributions/* {version}.RC#
    svn add {version}.RC#/apache-geode-examples-*
    svn commit -m "Adding examples to Apache Geode {version}.RC# distribution"


  14. Tag the release candidate in geode-examples.

    Code Block
    # then tag the release candidate commit
    cd ${GEODE_EXAMPLES_SRC}
    git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0"
    git push origin rel/v{version}.RC#


    Info

    If you are running on linux, you may see this error message:

    error: gpg failed to sign the data

    error: unable to sign the tag

     If you get that error message, try to sign some random file so that gpg will unlock your keyring. After that the git tag -s should work.


  15. Make sure you have the native client required components installed. On a Mac

    Code Block
    brew install cmake
    brew install doxygen


  16. Checkout geode-native from https://github.com/apache/geode-native. Then `cd` into the geode-native directory, create a build directory, configure cmake and generate the source distribution via cpack

    Code Block
    languagebash
    mkdir build
    cd build
    cmake .. -DPRODUCT_VERSION={version} -DOPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2* -DGEODE_HOME=your_geode_checkout/geode-assembly/build/install/apache-geode
    cpack -G TGZ --config CPackSourceConfig.cmake


  17. This should have generated a tar file and a corresponding checksum file. Let's sign the package:

    Code Block
    languagebash
    gpg --armor -u {key ID} -b apache-geode-native-*-src.tar.gz

    Verify that the command created a new file called `apache-geode-native-{version}-Source.tar.gz.asc`.

  18. Copy files into release distribution

    Code Block
    languagebash
    cd dist/dev/geode
    cp ${GEODE_NATIVE_SRC}/build/apache-geode-native-{version}* {version}.RC#
    svn add {version}.RC#/apache-geode-native-*
    svn commit -m "Adding Geode Native source distribution to Apache Geode {version}.RC#"



  19. Code Block
    # then tag the release candidate commit
    cd ${GEODE_NATIVE_SRC}
    git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0"
    git push origin rel/v{version}.RC#


...