This document is intended to be used and kept up to date by the Fedora Release Manager. It details the steps necessary to perform an official release of Fedora.
The release version in the documentation below is identified as
, replace this in the instructions with the current release (eg 4.0.1).
X is the major point version, Y is the minor point version, and Z is the maintenance point.
The previous release version (snapshot previous documentation) is identified as
, replace this with the previous release (eg 4.0).
Before Release Day
Verify release privileges
To make sure release day goes smoothly, you should ensure that:
- You have an account with commit access for the fedora project on github. As a committer, you should already have this level of access.
- You have an account with edit privileges on the duraspace.org Confluence wiki.
- You have an oss.sonatype.com account and have requested to be given permission to publish to the org.fcrepo groupId by adding a comment to the Fedora Sonatype Hosting Ticket
- You have project configuration privileges on JIRA (you'll see an error here if you don't)
- Your maven settings.xml includes the following:
Note about encrypted passwords
Encrypted passwords works for the plugin that references the sonatype-nexus passwords, but NOT the one that uses github. To avoid a cryptic error, enter your github password in plaintext.
Ensure you have a trusted code signing key
Prepare and distribute test plan
The test plan should also be ready prior to code freeze.
It should include:
- Which platform/configuration combinations will be tested
- Which automated tests will be run, and by whom
- Which manual tests will be run, and by whom
- Which service compatibility tests (external search, external triplestore) will be run, and by whom
- Instructions on how testers will report on test results
Create release branch and begin final test phase
Create a release candidate branch, release testing wiki page and notify developers to test.
Update online resources
If any online resources have been modified or added to during the release, these must be updated.
Determine which modules will be released.
Of the projects in https://github.com/fcrepo4. which should be released. Typically we keep the release versions in sync for those that have had a formal release.
Based on the modules to be released, create a release process spreadsheet like this.
Due to dependency chains, the following release order is required. Furthermore, the artifacts of dependencies must be propagated to maven central before the next one can be released.
- fcrepo-build-tools: if schedule for a release, must be handled first since it's version number is present in the other modules
- fcrepo4: the main project, always part of a release, takes the vast majority of the time (also push gh-pages)
- fcrepo-message-consumer (also push gh-pages)
- fcrepo-module-auth-rbacl (also push gh-pages)
- fcrepo-module-auth-xacml (also push gh-pages)
- fcrepo-camel (also push gh-pages)
- ontology (no push to sonatype)
- --- labs below
- fcrepo4-client (also push gh-pages)
- fcrepo-audit (also push gh-pages)
- fcrepo-camel-toolbox (also push gh-pages)
- fcrepo-webapp-plus (no push to sonatype)
- fcrepo4-release-tests (ditto)
- fcrepo4-oaiprovider (ditto)
- fcrepo4-swordserver (ditto)
- migration-utils (ditto)
- fcrepo4-upgrade-utils (ditto)
- fcrepo4-vagrant (update versions)
- fcrepo-karaf (update versions)
Merge the release candidate branch into master (if any commits were made)
Build and release the final distribution to Maven Central
It may be best to create fresh clones of the to-be-released projects, perhaps in well-named release folder. Leaving these directories pristine may help in the event that you wish to roll back or otherwise deal with an unexpected error.
In order to build the release make sure that:
- you have a working PGP installation with your code signing key as the default key
Run the following commands to generate and upload all built artifacts to the Sonatype staging repository (for example, X.X.X = 4.3.0 and X.X.Y = 4.3.1-SNAPSHOT) :
Review the local commits for correctness (`git diff HEAD~1`, and `git diff HEAD~2`)
- Remove/or move local Maven repository
- Checkout tag
- Build/Test release tag
- Push tags and commits to GitHub
Up until this point, all of the changes made are strictly in your local repository and working directory. From this point on, the changes you make will be visible to the world and in some cases difficult to back-out of.
- return to the release tag
- Deploy to Sonatype
Login to https://oss.sonatype.org
Point of no return
The following steps, once completed are final. They cannot be undone, revoked or altered. Only proceed if you've completed all the above steps and are absolutely certain the release is ready for publication.
Find the staging repository, check that it looks good, and "Close" it. Then "Release" it. This will publish the artifacts to the Sonatype releases repository and start the process of syncing them with central. The artifacts may take several hours to reach central. When finished, they'll be available at http://repo1.maven.org/maven2/org/fcrepo.
Build GitHub documentation site
Checkout release tag for publishing the release documentation
Update index.html pages in branch "gh-pages" for releases projects: fcrepo4, and fcrepo-camel-toolbox
Error creating blob: API rate limit exceeded
Github only allows a certain number of requests per hour. Once that number is hit you'll have to wait an hour before resuming your operation. The site documentation may exhaust this limit several times.
If you get the following error:
Error creating blob: You have triggered an abuse detection mechanism and have been temporarily
blocked from calling the API. Please retry your request again later. (403)
You may consider using the patched version of site-maven-plugin: https://github.com/awoods/maven-plugins/commit/c62c7b168375e3bfaf0dec7de2fa5fc03d8ed173
Create GitHub release
Under GitHub account/releases, select "Draft new release".
- Write a description
Create MD5 and SHA1 files for each of the release artifacts
- Upload artifacts to GitHub release (war, war.md5, war.sha1)
- See the artifacts found in "Downloads" to know which need to be uploaded to GitHub
Complete the Duraspace wiki documentation updates
Current, in-progress Fedora Repository Documentation wiki: https://wiki.duraspace.org/display/FEDORA4x
At the very minimum, update the following:
Note the version of Java against which the release was built.
If this is a new major or minor point release, copy the current, in-progress documentation to create the release wiki, then update accordingly. Mark the new pages as current, and update the pages in the previous documentation to indicate they are out-of-date.
Add the following header to the previous major release wiki space (see: Space Admin -> Themes -> Configure Theme)
If this is a maintenance point release, create separate child release note pages for each release covered by the documentation.
Otherwise, post the release notes in the Release Notes page (see Fedora 4.0.0 Release Notes for an example).
Update any other documentation as needed, per changes/features added with this release.
Make sure the license and copyright information is up-to-date with this release.
Close the release in Jira, and create the next one
- Go to the release management page.
- For the release you just made (there should be an open package icon to the left of it)
- click the gear icon on the left and choose "release"
- enter the date you finished the release
- the package should be closed
- if you are not already listed as the release manager in the description, enter "Release Manager: your-name-here"
- Create the next release
- enter a name (ie, Fedora 4.x.y) in the form at the top, and click Add. If the release manager is known, enter that in the note.
Update the Fedora Repository site
Fedora Repository site (Drupal): http://www.fedorarepository.org/
- No need to perform this step until the website refactor has been performed.
Let Carol Minton Morris know that the release is complete and can be announced.