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

    - 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
    languagebash
    titleassemble_content.txt
    #remove the existing assembly_content.txt
    rm  geode-assembly/src/integrationTest/resources/assembly_content.txt
    
    
    #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-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
    # 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
    # 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
    languagebash
    titledependency_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
    titlePublish the release branch
    git add .
    git commit -a -m "Upgraded version number for releasing {version}"
    pit push origin release/{version}

    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}

    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

    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}

Release Doc preparation:

...

  1.  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}



  2. 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}



  3. 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

    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}


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.



Prepare develop branch for the next release

  1. gradle.properties
      1. update versionNumber to the next release version (for example: if you created release branch for 1.8.0 update version number to 1.9.0 in the below files in develop branch)
      2. ensure that releaseType has -SNAPSHOT in it.
  2. geode-core/src/main/java/org/apache/geode/internal/Version.java
      1. Add the new ordinal

        Code Block
        languagejava
        titleNew ordinal
        //Add 5 to the previous ordinal
        private static final byte GEODE_190_ORDINAL = 100;


      2. Add the new version 

        Code Block
        languagejava
        titleAdding the new version
        public static final Version GEODE_190 =
            new Version("GEODE", "1.9.0", (byte) 1, (byte) 9, (byte) 0, (byte) 0, GEODE_190_ORDINAL);


      3. Set the current version to the new version

        Code Block
        languagejava
        titleSet current to new version
        public static final Version CURRENT = GEODE_190;



      4. Update the highest version

        Code Block
        languagejava
        titleSet current to new version
        public static final int HIGHEST_VERSION = 105;


  3.  geode-core/src/main/java/org/apache/geode/internal/cache/tier/sockets/CommandInitializer.java
      1. Add the next version to addCommands

        Code Block
        languagejava
        titleCommandInitializer
        ALL_COMMANDS.put(Version.GEODE_190, commands);



  4. Update the version in geode-book/config.yml on develop.
  5. Update the expected-pom.xml files

    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 pom-default.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

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.

Prepare develop branch for the next release

  1. gradle.properties
      1. update versionNumber to the next release version (for example: if you created release branch for 1.8.0 update version number to 1.9.0 in the below files in develop branch)
      2. ensure that releaseType has -SNAPSHOT in it.
  2. geode-core/src/main/java/org/apache/geode/internal/Version.java

    Add the new ordinal

    Code Block
    languagejava
    titleNew ordinal
    //Add 5 to the previous ordinal
    private static final byte GEODE_190_ORDINAL = 100;

    Add the new version 

    Code Block
    languagejava
    titleAdding the new version
    public static final Version GEODE_190 =
        new Version("GEODE", "1.9.0", (byte) 1, (byte) 9, (byte) 0, (byte) 0, GEODE_190_ORDINAL);

    Set the current version to the new version

    Code Block
    languagejava
    titleSet current to new version
    public static final Version CURRENT = GEODE_190;

    Update the highest version

    Code Block
    languagejava
    titleSet current to new version
    public static final int HIGHEST_VERSION = 105;
     geode-core/src/main/java/org/apache/geode/internal/cache/tier/sockets/CommandInitializer.java

    Add the next version to addCommands

    Code Block
    languagejava
    titleCommandInitializer
    ALL_COMMANDS.put(Version.GEODE_190, commands);
  3. Update the version in geode-book/config.yml on develop.
  4. Update the expected-pom.xml files

    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 pom-default.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

    - 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
    languagebash
    titleassemble_content.txt
    #remove the existing assembly_content.txt
    rm  geode-assembly/src/integrationTest/resources/assembly_content.txt
    
    #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-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
    # 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
    # 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
    languagebash
    titledependency_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 develop branch to origin

    Code Block
    titlePublish the release branch
    git add .
    git commit -a -m "Upgraded version number for releasing 1.x.x"
    pit push origin develop



...