You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 56 Next »

Introduction

Following picture demonstrates release stages sequence.

Ignite Release Process


P0. Initializing

Release phases dates are discussed, as release manager during the first discussion. Release Manager should be PMC Member.

Moving scope freeze and code freeze dates maybe not the best option since a lot of contributors synchronize their efforts to make feature completed by particular moment.

Once release manager found, he/she can setup environment.

Prerequisites for release manager

0.1. Write access to Apache Ignite GIT & SVN repository (commiter role) - https://gitbox.apache.org/repos/asf?p=ignite.git

0.2. Access to Team City Release tasks - https://ci.ignite.apache.org/project.html?projectId=ApacheIgniteReleaseJava8 If you don't have necessary rights ask for assigning on dev. list.

0.3.Your GPG key available in https://apache.org/dist/ignite/KEYS - Steps to add:

Following setup is performed only once.  Check README.txt from https://github.com/apache/ignite-release/tree/master/scripts This readme file contains some additional requirement and setup steps.


0.3.1. If you don’t have your Apache key set up, please see https://www.apache.org/dev/openpgp.html#home on how to generate a new key.

Steps to be followed:

  • Setup gpg home (optional) and configuration file (gpg.conf) according to the page.
  • Check version and settings using `gpg --version` (version >1.4.1, SHA512 is recommended).
  • Generate new key pair `gpg --gen-key` Parameters: RSA/4096/never expires/use your name and apache email/comment: `CODE SIGNING KEY`. Let's suppose generated key name is 612654F7.
  • Check preferences using `gpg --edit-key 612654F7` and sub-command `showpref`

0.3.2. Export key to Apache SVN. See section 'Create/Import your pgp secret key' in Readme.txt in https://github.com/apache/ignite-release/tree/master/scripts

  • Make sure you have SVN client. You can install TortoiseSVN for convenience (don’t forget to select command line tools for having svn executable). Alternatively, you can install SVN package from https://subversion.apache.org/packages.html

Steps to be followed:

gpg --list-sigs 612654F7 >> KEYS
gpg --armor --export 612654F7 >> KEYS


0.3.3. Export the key to a Public Key Server

To publish key follow instructions from https://www.apache.org/dev/openpgp.html#publish-in-web-space

You may use

gpg --send-key 612654F7

alternatively, you

- can export key to an .asc file (gpg --armor --export 6F6F6F6F > key.asc)

- and submit the key file content manually to a public key server.

For example, at MIT server you can just paste asc file content to a text field and submit: to http://pgp.mit.edu/ or to http://keyserver.ubuntu.com/

P1. Scope development and implementation

P1.1 Implementation and Scope Discussion

Difference between this and the following phase: it is not possible to move in-progress tickets to a next release because branches not diverged.

New branch creation moment is not formal, and it can happen just before or simultaneously with scope freeze.  The important thing is announcing this moment and reminding contributors to cherry-pick commits to release branch.

P1.2 Implementation and Scope Finalization

Removing issues from the scope based on estimated dates of completion, importance to release and on community discussion. Private discussion between contributors is possible, but it is recommended to discuss features in public to allow all community members to share their arguments and concerns.

The first step to be done to enter scope finalization phase it to create a branch in Ignite code base (origin). This moment be precisely the same with the start of P1.1 

1.2.1. Create release branch, e.g ignite-2.8, push it to the ASF repository

1.2.2. Run TC tests (on the appropriate branch), use https://ci.ignite.apache.org/viewType.html?buildTypeId=IgniteTests24Java8_RunAllNightly

1.2.3. Estimate state of TC, check failures history (if any).

1.2.4. Create scheduled build triggers for daily Run All (Nightly) run. Usually, triggers are set up using Apache Ignite TeamCity Bot (triggering of builds there depends on agent availability). Use an intellectual trigger to trigger release branch adaptively, or ask on the dev. list to add.

End of this phase is scope freeze.  

P2. Rampdown

This phase is some time to complete implementation of features from the initial scope. In parallel with implementation, some less essential fixes and features are moved to the next release. 

End of rampdown is code freeze. Code freeze is based on dates, but the actual time of freeze is determined by announcing.

P3. Stabilization

There only blockers are accepted. Usually it should be approval of release manager to each commit.

Note blockers here is not only a critical bug, but an issue in the product which makes product unstable or non-functioning, performance drop has proven by a benchmark, a security issue, or a regression of existing features.

P4. Vote preparation and Voting



Sending Release For Vote

After the community agrees that the codebase is ready for a release, release manager should send the release for a vote.

The email subject should be "[VOTE] Apache Ignite <version> <rc>", e.g. "[VOTE] Apache Ignite 1.5.0.final RC3". Here is the sample email.

Dear Community,

We have uploaded release candidate to
https://dist.apache.org/repos/dist/dev/ignite/2.7.5-rc3/
 
The following staging can be used for a dependent project for testing:
https://repository.apache.org/content/repositories/orgapacheignite-1438/

This is very important release containing initial versions of Ignite.NET
and Ignite C++ and many other important features.

Tag name is
1.5.0.final-rc3

1.5.0 changes:
* Ignite.NET: Initial Release.
* Ignite C++: Initial Release.
* Massive performance improvements for cache operations and SQL.
* Added new binary cache object marshalling implementation.
* Added IgniteSemaphore data structure.
* Added MQTT Streamer.
* Added Twitter Streamer.
* Added Ignite Sink (integration with Apache Flume).
* Fixed optimistic serializable transactions: implemented "deadlock-free"
locking algorithm.
* Fixed failover for continuous queries.
* Fixed compilation and runtime errors under OpenJDK and IBM JDK.
* Fixed Integer.size limitation for cache.
* Fixed and improved cache types configuration.
* Fixed cache rebalancing.
* Many stability and fault-tolerance fixes.
* Added example to demonstrate the usage of EntryProcessor.

Complete list of closed issues:
https://issues.apache.org/jira/issues/?jql=project%20%3D%20IGNITE%20AND%20fixVersion%20%3D%201.5%20AND%20status%20%3D%20closed

DEVNOTES
https://git-wip-us.apache.org/repos/asf?p=ignite.git;a=blob_plain;f=DEVNOTES.txt;hb=refs/tags/1.5.0.final-rc3

RELEASENOTES
https://git-wip-us.apache.org/repos/asf?p=ignite.git;a=blob_plain;f=RELEASE_NOTES.txt;hb=refs/tags/1.5.0.final-rc3

The vote is formal, see voting guidelines https://www.apache.org/foundation/voting.html
+1 - to accept Apache Ignite 1.5.0.final-rc3
0 - don't care either way
-1 - DO NOT accept Apache Ignite 1.5.0.final-rc3 (explain why)

This vote will be open for 72 hours till May 23, 14:00 UTC.
https://www.timeanddate.com/countdown/to?year=2019&month=5&day=23&hour=14&min=0&sec=0&p0=utc-1

Release Verification

  • Check that all JIRA issues for the specific version are Closed (example JQL: `project = IGNITE AND fixVersion <= 1.7 AND status != closed`).

    curl "https://issues.apache.org/jira/rest/api/2/search?jql=project=ignite%20AND%20status%20!=%20closed%20AND%20fixVersion<=1.7&fields=summary" | grep '"total":0,"issues":\[\]'


  • Check that sha1 & md5 checksum is correct. 

    sha1sum -c *.sha1
    md5sum -c *.md5
  • Check that signature is correct.

    gpg --verify-files *.asc
  • Check that version is correct.
  • Check licenses from the source code.

    mvn clean validate -DskipTests=true -P check-licenses
  • Build the binary releases from the source code.

    mvn clean package -DskipTests -Dignite.edition=hadoop
    mvn clean package -DskipTests
  • Build Ignite.NET binaries and NuGet packages

    cd modules\platforms\dotnet
    build -skipJava
  • Do some trivial checks, e.g. start local topology, run several examples from binaries gained at previous step. Unpacked binaries can be found at sources/target/release-package

Closing Vote

After vote passes someone from PMC should do the following:

  • Upload documentation to https://svn.apache.org/repos/asf/ignite/site/trunk/releases/<version>

    svn import apache-ignite-fabric-<version>-bin/docs https://svn.apache.org/repos/asf/ignite/site/trunk/releases/<version> -m "new Release (<version>)" 
  • Update https://svn.apache.org/repos/asf/ignite/site/trunk/download.html (add new release to tables and mark them as latest, if necessary)
  • Move release to https://dist.apache.org/repos/dist/release/ignite/<version

    svn mv https://dist.apache.org/repos/dist/dev/ignite/<version><rc> https://dist.apache.org/repos/dist/release/ignite/<version> -m "Release <version>"
  • Create Release tag from RC tag

    git tag -a <version> -m "<version>"
    git push origin <version>
  • Send an email with subject "[RESULT] [VOTE] Apache Ignite <version> Release (<rc>)", for example "[RESULT] [VOTE] Apache Ignite 1.4.0 Release (RC1)" and body similar to: 

    Hello!
    
    Apache Ignite 1.4.0 release (RC1) has been accepted.
    
    9 "+1" votes received.
    
    Here are the votes received:
    
       - Denis Magda (binding)
       - Anton Vinogradov (binding)
       - Alexey Kuznetsov (binding)
       - Sergi Vladykin (binding)
       - Gianfranco Murador (binding)
       - Vladimir Ozerov (binding)
       - Raul Kripalani (binding)
       - Konstantin Boudnik (binding)
       - Chandresh Pancholi
    
    Here is the link to vote thread -
    http://apache-ignite-developers.2346864.n4.nabble.com/VOTE-Apache-Ignite-1-4-0-Release-RC1-tp3474.html
     
    Ignite 1.4.0 successfuly released to https://dist.apache.org/repos/dist/release/ignite/1.4.0/
    
    Thanks!

     


Whenever consensus cannot be reached, standard Apache Voting Process will be used to reach a solution.

Post-release steps

After successful vote following actions should be done:

  1. Update version in the master branch (execute script and commit changes): ./scripts/update-versions.sh 2.9.0
  2. Release all the documentation (Java, .NET, C++, etc.) on apacheignite.readme.io. Make sure to update a documentation's version to a version of the release.
  3. Update the latest doc reference on ignite.apache.org:
    1. Update the new version number on the .htaccess file: RewriteRule ^releases/latest/(.*)$ /releases/1.9.0/$1 [L]
    2. Add the following tag to all .html files: <link rel="canonicalhref="https://ignite.apache.org/releases/latest/LANGUAGE-DIR/FILENAME.html" />
    3. Use the script that automates the update or contact Mauricio Stekl (mauricio@gridgain.com) who can assist with this step.
  4. Update Ignite version in this file - https://ignite.apache.org/latest
  5. Mark JIRA version as released.
  6. Update https://ignite.apache.org with new download links, make sure to use [preferred]/[distdir] and [disturl]/[distdir]: https://svn.apache.org/repos/asf/ignite/site/trunk
  7. Prepare the cloud images and update links to them here https://ignite.apache.org/download.cgi#docker. In addition, update the links to the images on the following documentation pages whenever is needed:
    1. http://apacheignite.gridgain.org/docs/docker-deployment
    2. https://apacheignite.readme.io/docs/aws-deployment
    3. https://apacheignite.readme.io/docs/google-compute-deployment
  8. Update Web Console docker image: https://hub.docker.com/r/apacheignite/web-console-standalone/tags/
  9. Delete previous releases from https://dist.apache.org/repos/dist/release/ignite/..., replace their download URLs by https://archive.apache.org/dist/ignite/...
  10. Release maven staging (https://maven.apache.org/developers/release/maven-project-release-procedure.html).
  11. Upload .NET NuGet packages to nuget.org. Credentials can be found in https://svn.apache.org/repos/private/pmc/ignite/credentials/nuget.org (PMC only).
  12. Make sure that the artifacts were synced up to http://repo2.maven.org/maven2/org/apache/ignite/ and Maven Central. Refer to the recently happened issue ( Unable to render Jira issues macro, execution error. )
  13. Announce the release by sending a single message to announce@apache.org and Ignite's user/dev lists. Refer to the examples below:
    1. http://apache-ignite-developers.2346864.n4.nabble.com/ANNOUNCE-Apache-Ignite-2-1-0-Released-td20145.html
  14. Announce security vulnerabilities that were fixed in the release following the ASF process https://www.apache.org/security/committers.html. Check with security@ignite.apache.org if there are any vulnerabilities. 
  • No labels