This page describes process and provides instructions to release manager on how to release Apache Ignite
Following picture demonstrates release stages sequence.
Table of contents
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.
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:
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
Steps to be followed:
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
- 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.
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.
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 as the start of P1.1
1.2.1. Create release branch, e.g ignite-2.8, push it to the ASF repository. (optional) consider creating PR for release, having PR is convenient because GitHub will notify you about commits to the branch.
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.
1.2.5. Create/schedule the nightly release build triggering – Releases Apache Ignite Nightly (may require TC permissions).
End of this phase is scope freeze.
This phase is some time to complete the 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 ramp-down is code freeze. Code freeze is based on dates, but the actual time of freeze is determined by announcing.
During the stabilization phase, only blockers are accepted. Including anything to the release should be approved by the release manager for each commit.
Note blockers defined here not as any critical bug, but
Once all changes are applied, it is possible to prepare a release candidate. It is possilbe to build several release candidates without starting a vote. First RCs can have part of changes scheduled for release.
4.0.1. Collect Release Notes (this action is manual now). Consider preparing HTML file in addition to text for future step 6.3.6. Check all completed tickets from the release page. Ticket may or may not have release notes, and this depends on if it is reasonable to mention change for users.
4.0.2. Optionally you may ask for a review of resulting release notes on the list.
4.0.3. Update RELEASE_NOTES.txt and commit Release Notes changes into master and a release branch.
Update version in the release branch (execute the script from Ignite project root directory, you can use WSL or GitBash on Windows):
and commit changes. This step is essential for release because later the source code will be published into SVN. Version update is required to be committed before RC building.
In the release branch, open the docs/_config.yml file and update the version property with the release number.
Double-check that year in copyright messages is correct. If the release is minor and based on an older branch, this branch can contain an outdated value of the year. Fix if needed. Example commit of updating year.
Following step is not actual since 2.8, there is the feature for an auto-generating year: Update copyright year manually in IgniteVersionUtils
Version of packages update is not automated since it requires to add verison to history to update it. Update is more or less similar to this commit
Check dates are correct, and version is postfixed with '-1' - it is package version number, it is required by format
and add lines similar to following after change log
Make sure dates are correct, add package build number, '-1' at the end of package version.
126.96.36.199. (optional) ask for review on the list.
188.8.131.52. Commit package version changes into master and a release branch.
Run [RELEASES] Apache Ignite / Main  Release Build for ignite-x.y or for ignite-x.y.z branch. You will need to enter version number (value if x.y.0 or x.y.z), and specify release candidate number. For testing purposes, it is recommended to use rc0. You may several times re-build same rc- number.
Download and unzip release archive. It can be found at "Artifacts" tab on build page. Example:
Do some checks related to release (full list of check to be done can be found in section 5.1):
Run vote scripts to prepare RC before voting. You may skip steps 4.4.1 & step 4.4.2 in case you want to run some testing of release. In case release build was made for testing-only purposes, you can go to step 4.4.3 in this section.
Run script vote_1[git]create_rc_tag.sh Example of script output:
Please, check corresponding git tag is created and is available in ASF repository: https://gitbox.apache.org/repos/asf?p=ignite.git;a=tags
Note: If you've already uploaded staging, you should remove it from nexus - https://repository.apache.org/#stagingRepositories
Run script ./vote_2\[mvn\]\[pgp\]deploy_to_staging.sh Example of script output:
Go to Nexus UI https://repository.apache.org/#stagingRepositories, log in using Apache credentials and close repository.
Provide some comment for closing repository, e.g. `Repository for Apache Ignite 2.7.6 - RC0`.
Close is a heavy background process, which makes repository visible for others. After some time, check if the repository closed successfully and visible.
Once repository is closed, write down a link to content, e.g. https://repository.apache.org/content/repositories/orgapacheignite-1464/ This link is useful for vote thread and sharing with others, who is going to test RC.
Pre-build packages can be found at 'release-2.7.6-rc0\packages' folder of release candidate archive.
Building packages locally supported only on Linux, WSL not supported. Steps to build from scratch (optionally):
Note: The following script is locale-specific. You should execute it on the en locale
Run script ./vote_3_step_1\[packages\]\[optional\]build.sh . Example of output:
Build script will sign artifacts automatically (in case of build locally), but TC pre-build packages need to be signed by release manager key.
Find your public key ID by running
Key Id will look like as 16 hexadecimal, e.g., 612654F7; it is the same value from step 0.3.2.
Sing RPM pre-build package by command
Sign DEB pre-build package by command
You can validate that file modification time was changed after singing.
Run script vote_3_step_2[pgp]sign_artifacts.sh . Example of script output
Please check results at ./svn/vote. Optionally you may also check hash/sign using https://www.apache.org/info/verification.html
Run script vote_3_step_3[svn]deploy_artifacts.sh. This script will upload your local artifacts to a a development area under e.g.
https://dist.apache.org/repos/dist/dev/2.7.0-rc0 which is used for staging releases candidates.
Each ASF committer has a write access to this area – WHERE CAN I STAGE A RELEASE CANDIDATE?
Example of output:
Check binaries and sources are available in the SVN: https://dist.apache.org/repos/dist/dev/ignite/
There is TC task for generating report containing difference comparing current release with previous.
You should run it and do sanity check for a changed files.
To start the build you need to specify current (staging) version and released version of Apache Ignite. See "Artifacts" tab to get task results. Example:
For 2.7 release "apache-ignite-hadoop" removed and some new dependencies introduced for a benchmarks.
Run ' Apache Ignite Release Vote | Check RC' https://ci.ignite.apache.org/buildConfiguration/ApacheIgniteReleaseJava8_PrepareVote4CheckRcLicensesChecksum
This step will validate hashes, Javadoc, build from sources, licenses. So it it required to run it to simplify/skip some local checks from section 5.1.
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] Release Apache Ignite <version> <rc>", e.g. "[VOTE] Release Apache Ignite 2.7.5 RC4".
Vote email should include reference that vote is formal and votes meaning for +1,0,-1.
Here is the sample email:
Optionally you can create a separate discussion for questions related to RC: Discussion on 2.7.5
All community members are encouraged to verify release. PMC members have a binding vote, but each vote matters.
The following list are steps, which can be done by each member, see also https://www.apache.org/info/verification.html
It is not a complete list, community members can test any module or feature of the product.
Check that all JIRA issues for the specific version are Closed (example JQL: `project = IGNITE AND fixVersion <= 1.7 AND status != closed`).
Check that sha1 & md5 checksum is correct.
Check that signature is correct.
Check licenses from the source code.
Build the binary releases from the source code.
Build Ignite.NET binaries and NuGet packages
See also Incubator Release Checklist for more checks.
In case there is -1 vote present (it is not a veto, even if it was casted by PMC), release manager has ultimate rigth to cancel vote immediately to fix related issues.
Usually +1 means that community member agrees that current release is better with previous.
Usually with +1 member shares which checks were done.
Vote should be open for at least 72hours. In case insufficient votes are available vote can be kept open as long as it needed without additional announce. But in this case release manager has option to close the vote as unsuccessfull in case time is out.
Whenever consensus cannot be reached, standard Apache Voting Process will be used to reach a solution.
Send an email with subject "[RESULT] <vote subject>" ("[RESULT] [VOTE] Release Apache Ignite <version> (<rc>)") and provide vote results: if it passes or not, provide voting details.
In case vote is unsuccessful or closed by release manager, prepare new release candidate with fixes starting from step 4.2
In case vote was sucessfull, run release* scripts from release candidate local home from step 4.2.1.
Run release_1[svn]move_binaries.sh (Note: Only PMC members have write access to the release repository). Example of output
Manual alternative of this script is move release to https://dist.apache.org/repos/dist/release/ignite/<version>
Result should be available at https://dist.apache.org/repos/dist/release/ignite/
Please check results at:
* binaries: }
There can be some sync lag with moving files and availability at
During running script you will be asked for auth API key to upload. Login to the https://apache.jfrog.io/ui/ with Apache ID credentials and get the API key from the authentication settings.
Run script release_2[bintray]upload_packages.sh, example of output
Run Script release_3[git]deploy_docs_to_site.sh
This script will checkout ignite-website from GIT, copy API documentation, and push changes back.
Check results availability at https://gitbox.apache.org/repos/asf?p=ignite-website.git;a=tree;f=releases;hb=refs/heads/master
Run script release_4[git]create_release_tag.sh Example of output
This step can be done manually :
Create Release tag from RC tag
Please check results at https://gitbox.apache.org/repos/asf?p=ignite.git;a=tags
Release maven staging (https://maven.apache.org/developers/release/maven-project-release-procedure.html).
Go to Nexus UI https://repository.apache.org/#stagingRepositories, login using Apache credentials and release repository for accepted release candidate. You can release it by pressing the Release button (provided that you have successfully closed the staging repository).
This will move the components into the release repository of OSSRH where it will be synced to the Central Repository (see also https://central.sonatype.org/pages/releasing-the-deployment.html#close-and-drop-or-release-your-staging-repository)
The sync into Maven Central central staging from repository.apache.org occurs every 4 hours. There is a separate hourly schedule that runs which pushes from staging to the other central machines, and then updates the indexes.
Execute the script from Ignite project root directory, this will update version in the master branch :
and commit changes. This step is not required if minor release was issued,e.g. 2.7.5
The dependency of ignite-extensions must be updated according to the new version in the master branch.
See the example below:
Publish the technical documentation on the website: How to Document - Publishing to the website
Update the latest APIs doc reference on ignite.apache.org:
This script does some Search engine optimization (SEO) updates to new/old .html files, like adding NOINDEX metatag to older version; add canonical URL to latest docs; and add GA code.
Checkout GIT repository for Apache Ignite site: https://gitbox.apache.org/repos/asf/ignite-website.git
Just copy-paste latest release notes from previous release, replace text formatting with headers, lists items.
Place these notes to corresponding release folder, for example releases/2.7.5. If folder is absent, check results of step 6.2.3.
Commit and push changes. File should be available on the site automatically.
Once the new release is published to dist.apache.org/release wait a day or so for mirrors to catch up.
After the release was propagated across all the mirrors, update the "Source Releases" and "Binary Releases" sections of the website downloads page:
Find `latest` text file in GIT repository for Apache Ignite site.
Update Ignite version in this file. Commit changes and check result at https://ignite.apache.org/latest
Go to JIRA project administration, select Apache Ignite, select Versions, select appropriate version and select Actions->Release.
This section Intended for preparing a docker image for https://apacheignite.readme.io/docs/docker-deployment
Prerequisite: Docker installed. For example, for Windows you can download https://docs.docker.com/docker-for-windows/ You may need to register at docker hub.
Credentials can be found in SVN:
https://svn.apache.org/repos/private/pmc/ignite/credentials/hub.docker.com.txt (PMC only)
You can get a binary distribution from the 'vote' folder of the release candidate.
Follow instructions from the README file and Dockerfile are available at:
To build an x86_64 image run the following command (insert correct release number):
This build takes a distribution from some folder named like apache-ignite*
You can validate image created by calling
Run image to check it works well:
To publish image run
Check results at https://hub.docker.com/r/apacheignite/ignite
Todo: add description of steps ?
In addition, update the links to the images on the following documentation pages whenever is needed:
Todo: add description of steps ?
Prepare the cloud images and update links to them here https://ignite.apache.org/download.cgi#docker.
Replace their download URLs by https://archive.apache.org/dist/ignite/...
Delete unsucessfull release candidates and packages (if any) from dev section of Apache SVN repository https://dist.apache.org/repos/dist/dev/ignite/
Retrieve all .nupkg files from build artifacts of step 4.5
You may need to install client tools for .NET https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools (download file & add it to PATH). You can use nuget.exe 4.x version (because NuGet.exe 5.0 and later require .NET Framework 4.7.2 ).It may be required to configure nuget.exe using NuGet.Config(XML) https://docs.microsoft.com/en-us/nuget/tools/cli-ref-push for using nuget.org as default push source.
You can find configuration file under user home directory, for example, on Windows
Configuration on Linux can be skipped. The push source is set up by -s param in the script.
Example of configuration:
Credentials (API key to push packages) can be found in https://svn.apache.org/repos/private/pmc/ignite/credentials/nuget.org (PMC only, use Apache ID to login).
Windows, .NET Classic, PowerShell:
Power shell example ouptput:
Linux, .NET Core, sh:
Check result at https://www.nuget.org/packages/Apache.Ignite/
Packages become visible from UI with some delay (~5-10 minutes)>
Usually, this sync should be completed in 4 hours after releasing repository at step 6.3.1. If it is not released, contact infra.
Create a new issue to enforce compatibility checks and prepare the PR. Add the released version to the IgniteReleasedVersion enum. Ask for a review on dev-list if necessary.
Prepare a new blog post with the most major and meaningful release improvements.
Post this on - https://blogs.apache.org/ignite/ (ask Maxim Muzafarov or Denis A. Magda if there is any help required with the publication).
Announce the release by sending a single message to firstname.lastname@example.org and Ignite's user/dev lists.
Please note that the 'announce 'list is ASF-level list and not all subscribers are aware of Apache Ignite. So it is recommended to include a short description of the project and put the link to the post from the 6.4.0.
Only PMC and Committers are able to send to the 'announce list.
Refer to the examples below:
If release includes any fixes for the security issue, then announce security vulnerabilities that were fixed in the release.
Follow the ASF process https://www.apache.org/security/committers.html.
Check with email@example.com if there are any vulnerabilities.
Matrix is stored in ASF-level SVN: https://svn.apache.org/repos/asf/infrastructure/site/trunk/content/licenses/exports/index.page/eccnmatrix.xml
Only VP, product can commit to matrix source. Ask VP, Ignite on a list to update.
There are several unresolved issues / open questions:
6. Unclear on how to prepare/update 6.3.11.GCE&AWSvirtualmachines
7. Steps to be done to upload RPM/DEB packages