References to ASF official pages
http://www.apache.org/dev/mirrors (deprecated, historically interesting)
Things to check before a release (these tasks can be delegated by the RM (Release Manager))
- Check if there are any bugfixes in trunk which need to be backported to the release branch (see How should committers handle backporting?).
- Check all files are correctly licensed at https://nightlies.apache.org/ofbiz/stable/rat-output.html. For that you can use
https://nightlies.apache.org/ofbiz/stable/rat-output.html for the current stable version
https://nightlies.apache.org/ofbiz/next/rat-output.html for the current next version, ie the version never released yet
You can include files that don't need license in https://github.com/apache/ofbiz-tools/blob/master/rat-excludes.txt
- Check no open blocker Jira issues are still pending:
T Key Summary Assignee Reporter P Status Resolution Created Updated Due
If you load a new gradle wrapper version, update shasum signature on $OFBIZ_HOME/gradle/init-gradle-wrapper.sh
- Check if there are deprecated services to remove. That's easily done by looking for "has been deprecated and replaced by" in console.log.
The workflow for a new release has four phases: preparing a candidate release, voting, publishing the release, announcing the release.
Preparing a Candidate Release
- Create a release tag named: release<YY.MM.NN>
- For example: release18.12.02
- Create the release tag on all the relevant repositories such as ofbiz-framework and ofbiz-plugins
- Export/extract the release branch in a local folder named apache-ofbiz-<YY.MM.NN>
- Modify the following files in the main folder:
- edit the LICENSE file: if it is a framework+plugins release then simply remove the LICENSE file under plugins; if it is a framework only release then edit the LICENSE file to remove the references to plugins; if it is a plugin release that add NOTICE and check the validity of the LICENSE file (or add one if missing);
- put the release version number in the VERSION file.
- Remove the Gradle wrapper bin files
- Compress the exported folder as apache-ofbiz-<YY.MM.NN>.zip
- Create an OpenPGP Compatible ASCII Armored Detached Signature named apache-ofbiz-<YY.MM.NN>.zip.asc
- Create an SHA512 Checksum named apache-ofbiz-<YY.MM.NN>.zip.sha512
- Commit the 3 release files to https://dist.apache.org/repos/dist/dev/ofbiz/
- Update the doap_OFBiz.rdf file
Voting on a release
The vote takes place in the developers mailing list. People who want to vote should do the following checks:
- check sha checksum of release zip file against the .sha file
- check signature of release zip file against the .asc file
- unzip the release file, build and run integration tests. The build should be successful.
The checksum and signature verification can also be done by the following convenience script (bash): https://github.com/apache/ofbiz-tools/blob/fdbae25fa8e11355742b403f72cb80f4a0c32262/verify-ofbiz-release.sh
Publishing the Release
After a successful vote, the Candidate Release becomes an official Release and can be published:
- move the release files from https://dist.apache.org/repos/dist/dev/ofbiz/ to https://dist.apache.org/repos/dist/release/ofbiz/
Announcing the Release
These steps can be done after at least 15 minutes after the release has been published (time required for the transmission of the release files to the CDN):
- Add a news item to the main page of the OFBiz website: http://ofbiz.apache.org/index.html
- Add the information about the release to the OFBiz download page: http://ofbiz.apache.org/download.html
- Create an html page with the release notes (generated by Jira)
- In Jira, mark the version as "released" and create a new version for the next release
- If necessary, update the security page on siote
- Add the information about the release to the release history page: http://www.apache.org/dist/ofbiz/
- Send an announcement to the user, dev and firstname.lastname@example.org lists; if the release contains vulnerability fixes send also to email@example.com
Update related files
Please complete the list if necessary...
- Update the release informations on other sites: OFBiz on other sites
- If it's an EOL release announce using one of the files at https://svn.apache.org/repos/private/pmc/ofbiz/security/EOL-Drafts
Creating a new release branch
From time to time, every 1-2 years, the OFBiz community create a release branch from the master branch in order to start the stabilization process.
This paragraph describes the steps involved in the creation of the release branch:
- Create a new branch named release<YY.MM>
- For example: release18.12 is the name of the release branch created in December, 2018
- Edit the VERSION file in the OFBiz home folder to contain the same <YY.MM> of the release branch
- In Jira, rename the version "Upcoming Branch" into "<YY.MM.01>" (i.e. the name of the first release of the new branch)
- In Jira, create a new version named "Upcoming Branch" and move to it all the open tasks that were assigned to "Upcoming Branch" and are not planned to be resolved in <YY.MM.01>
- Check Creating a new branch in BuildBot and update the BuildBot.md file
- Update the demos documentation, the next-manual and next patches files under demo-backup
- In the new main README.adoc change from trunk to release<YY.MM> where it fits
- Update the GitHub workflows files changing from trunk to release<YY.MM> where it fits.
Notably modify .github/workflows/codeql-analysis.yml, <<branches: "[ trunk ]">> to <<branches: "[ release<YY.MM> ]">
- Update the developers page on site: https://ofbiz.apache.org/developers.html
Branch EOL (End Of Life)
In order to help our users to decide about what to do with branches EOL we decide x months ago to send an announcement. When the time is passed we send a confirmation announcement about the EOL.