Page History

...

...

Creating the release branch:

1. Check for the most latest recent develop SHA that is passing passes all the tests and also 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
   title Create release branch
   git checkout -b release/{version}

   
   

4. gradle.properties

   1. 1. remove -SNAPSHOT in releaseType 
5. docker/Dockerfile
   1. 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
   title Updating 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 language bash title gradle build ./gradlew clean build -Dskip.tests=true - create a script in geode folder and assign executable permission. Code Block language bash title Update the expected pom files #!/bin/bash cp geode-assembly/build/publications/maven/pom-default.xml geode-assembly/src/test/resources/expected-pom.xml cp geode-common/build/publications/maven/pom-default.xml geode-common/src/test/resources/expected-pom.xml cp geode-concurrency-test/build/publications/maven/pom-default.xml geode-concurrency-test/src/test/resources/expected-pom.xml cp geode-connectors/build/publications/maven/pom-default.xml geode-connectors/src/test/resources/expected-pom.xml cp geode-core/build/publications/maven/pom-default.xml geode-core/src/test/resources/expected-pom.xml cp geode-cq/build/publications/maven/pom-default.xml geode-cq/src/test/resources/expected-pom.xml cp geode-dunit/build/publications/maven/pom-default.xml geode-dunit/src/test/resources/expected-pom.xml cp geode-experimental-driver/build/publications/maven/pom-default.xml geode-experimental-driver/src/test/resources/expected-pom.xml cp geode-json/build/publications/maven/pom-default.xml geode-json/src/test/resources/expected-pom.xml cp geode-junit/build/publications/maven/pom-default.xml geode-junit/src/test/resources/expected-pom.xml cp geode-lucene/build/publications/maven/pom-default.xml geode-lucene/src/test/resources/expected-pom.xml cp geode-old-client-support/build/publications/maven/pom-default.xml geode-old-client-support/src/test/resources/expected-pom.xml cp geode-protobuf-messages/build/publications/maven/pom-default.xml geode-protobuf-messages/src/test/resources/expected-pom.xml cp geode-protobuf/build/publications/maven/pom-default.xml geode-protobuf/src/test/resources/expected-pom.xml cp geode-pulse/build/publications/maven/pom-default.xml geode-pulse/src/test/resources/expected-pom.xml cp geode-rebalancer/build/publications/maven/pom-default.xml geode-rebalancer/src/test/resources/expected-pom.xml cp geode-wan/build/publications/maven/pom-default.xml geode-wan/src/test/resources/expected-pom.xml cp geode-web-api/build/publications/maven/pom-default.xml geode-web-api/src/test/resources/expected-pom.xml cp geode-web/build/publications/maven/pom-default.xml geode-web/src/test/resources/expected-pom.xml - Delete the script and then build geode again and this time it should be successful. Do not skip documentation build. Code Block language bash title Build Geode #delete the script you created in the previous step rm <script-name>.sh #build geode , it should be successful this time. ./gradlew clean build -Dskip.tests=true - Update the file geode-assembly/src/integrationTest/resources/assembly_content.txt with correct version. This can be done manually or use the below steps. Code Block language bash title assemble_content.txt #remove the existing assembly_content.txt rm geode-assembly/src/integrationTest/resources/assembly_content.txt #go to the new build directory cd geode-assembly/build/install/apache-geode #Put the new files to a new assembly_content.txt find geode-assembly/build/install/apache-geode -type f | cut -c 43- | sort >> geode-assembly/src/integrationTest/resources/assembly_content.txt #Verify that these files have changed to the right version --- if you want to do it manually, these are the files in assembly_context.txt. #lib/geode-common-1.8.0.jar #lib/geode-connectors-1.8.0.jar #lib/geode-core-1.8.0.jar #lib/geode-cq-1.8.0.jar #lib/geode-dependencies.jar #lib/geode-jca-1.8.0.rar #lib/geode-json-1.8.0.jar #lib/geode-lucene-1.8.0.jar #lib/geode-old-client-support-1.8.0.jar #lib/geode-protobuf-1.8.0.jar #lib/geode-protobuf-messages-1.8.0.jar #lib/geode-rebalancer-1.8.0.jar #lib/geode-wan-1.8.0.jar #lib/geode-web-1.8.0.jar #tools/ClientProtocol/geode-protobuf-messages-definitions-1.8.0.zip #tools/Extensions/geode-web-1.8.0.war #tools/Extensions/geode-web-api-1.8.0.war #tools/Modules/Apache_Geode_Modules-1.8.0-AppServer.zip #tools/Modules/Apache_Geode_Modules-1.8.0-Tomcat.zip #tools/Modules/Apache_Geode_Modules-1.8.0-tcServer.zip #tools/Modules/Apache_Geode_Modules-1.8.0-tcServer30.zip #tools/Pulse/geode-pulse-1.8.0.war - Update the geode-assembly/src/integrationTest/resources/dependency_classpath.txt with the correct version numbers. Code Block language bash title dependency_classpath.txt #Manually change the version numbers in the below lines in the file: #geode-common-1.8.0-SNAPSHOT.jar #geode-connectors-1.8.0-SNAPSHOT.jar #geode-core-1.8.0-SNAPSHOT.jar #geode-cq-1.8.0-SNAPSHOT.jar #geode-json-1.8.0-SNAPSHOT.jar #geode-lucene-1.8.0-SNAPSHOT.jar #geode-old-client-support-1.8.0-SNAPSHOT.jar #geode-protobuf-1.8.0-SNAPSHOT.jar #geode-protobuf-messages-1.8.0-SNAPSHOT.jar #geode-rebalancer-1.8.0-SNAPSHOT.jar #geode-wan-1.8.0-SNAPSHOT.jar - Publish the release branch to origin Code Block title Publish 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 concerns are raised, we will start with the voting for the release candidate soon. Regards {Release Manager}

   
   

   
   

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

   No Format
   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 Manager}

   
   

...

1. Checkout the release branch.

2. Clean the directory

   Code Block
   language bash
   git clean -fdx

   
   

3. Edit ~/.gradle/gradle.properties with your PGP key and ASF LDAP information:

   Code Block
   language bash
   signing.keyId=01234567 # Your GPG key ID, as 8 hex digits signing.secretKeyRingFile=/path/to/secring.gpg # Normally in $HOME/.gnupg/secring.gpg nexusUsername=yourname # Your username on Apache's LDAP

   
   

4. Login Log in to repository.apache.org and select staging repositories. Find "orgapachegeode-####" and clink on "Drop"
   

5. 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
   language bash
   ./gradlew clean build uploadArchives -Paskpass #Sometime there may be an issue with gradle not picking up the credentials put in ~/.gradle/gradle.properties. # work around is to create a new directory somewhere eg. ~/gradle_home then create a new file in it called gradle.properties # Then run the command as ./gradlew --gradle-user-home=~/gradle_home clean build uploadArchives -Paskpass

   
   

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

   Code Block
   language bash
   #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"

   
   

7. Verify that all the artifacts have been uploaded to the nexus repository by logging into repository.apache.org and then click on close. Example:
   

8. 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
   language bash
   git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0" git push origin rel/v{version}.RC#

   
   

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

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

   
   

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

    Code Block
    version = 1.7.0 geodeVersion = 1.7.0

    
    

11. 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 ./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

    
    

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

    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"

    
    

13. 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#

    
    

14. 
    

    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.

    
    

    
    

...