You should have created a new page in the fedora release spreadsheet which will show what you need to release.
These variables will be used in the examples that follow. The exact values of ${ORG},
${REPO}, ${CURR} and ${NEXT}
will vary depending on which module and version is being released.
${ORG} = fcrepo # the github organization for the repository being released ${REPO} = fcrepo # the github repository name ${CURR} = 6.0.0 # the version currently being released ${NEXT} = 6.1.0-SNAPSHOT # the next snapshot version, this is normally the next minor release. i.e. 6.0.0 -> 6.1.0-SNAPSHOT or 8.3.2 -> 8.4.0-SNAPSHOT |
git clone https://github.com/${ORG}/${REPO} cd ${REPO} git checkout -b ${CURR}-RC origin/${CURR}-RC # check out the release branch mvn release:clean |
If mvn release:clean fails, you may need to revert the RC commit with |
The mvn release:prepare command will update all the POM files to set the tags and versions to the release version, create a commit along with a Git tag. Then change all the versions to the next development version and change the tag back to HEAD. This will be committed to the current branch as well.
mvn release:prepare -DreleaseVersion=${CURR} -DdevelopmentVersion=${NEXT} -Dtag=${REPO}-${CURR} -DautoVersionSubmodules=true -DpushChanges=false |
The above command arguments are:
|
You may be warned to update project versions. It will give you an option of which versions to update with options like (0: All, 1: Project Dependencies, ....). 1 (Project Dependencies) is the default and is the correct choice to select.
For any dependency it may ask for:
|
git diff HEAD~1 |
This will show changes from the commit before HEAD to HEAD. It should only show the changes from the release version to the new snapshot version and in at least one place the tag from ${REPO}-${CURR} to HEAD .
i.e. From 6.0.0 → 6.1.0-SNAPSHOT and fcrepo-6.0.0 → HEAD
See https://github.com/fcrepo/fcrepo/commit/8be5b22d9bb0f42b52ff0acf9294fd73fc493b99 for an example
git diff HEAD~2 HEAD~1 |
This will show changes from the commit 2 before HEAD to the commit before HEAD. It should only show the changes from the old SNAPSHOT version to the final release version and in at least one place the tag from HEAD to ${REPO}-${CURR}.
i.e. from 6.0.0-SNAPSHOT → 6.0.0 and HEAD → fcrepo-6.0.0
See https://github.com/fcrepo/fcrepo/commit/6a13e29dfd5931d3d7d182c841a23763bd8bf7bd for an example
Remove your local copies of Fedora artifacts to be sure of a clean build, and build the release.
rm -rf ~/.m2/repository/org/fcrepo git checkout $REPO-$CURR # detached head state i.e. > git checkout fcrepo-6.0.0 mvn clean install |
This ensures that all the dependencies can be downloaded from maven to build the artifacts.
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. Be aware. |
git push origin --tags |
The maven release task relies on the tag existing in the repository, make sure there is not a branch with the same name or it will be used instead and cause errors. |
This does not push the changes on to any branch. The commits exist on Github but are not associated with a branch, this will come later in case something goes wrong with Sonatype. |
Release the build artifacts to the Sonatype repository.
mvn release:perform -DperformRelease -Dgoals=deploy |
You will be prompted to enter your GPG passphrase. Ensure you have setup your ~/.m2/settings.xml
file with the servers defined on Fedora Release Process
|
|
The above has pushed artifacts to Sonatype in a staging repository. Now you can log in to Sonatype and release them if everything went well
Click Staging Repositories in left navigation
Search for "fcrepo" in upper right search box (project will not have the repository name in title)
If anything seems wrong, you should select the resource and click Drop. Then nothing is published to Sonatype. This will require re-running the release process to publish a new artifact to Sonatype, but better to be safe than sorry. If everything went smoothly and you are ready to release, select the resource and click Release. Again enter a brief description, the same "Release X.Y.Z" is fine as above. |
You have not pushed your commits to a branch on Github yet (See push changes to github). If you are NOT working on a past version release, i.e. you are releasing the latest version of the software. Now is a good time to push your main branch onto the repository. This should always be a fast-forward push and should never require a "force push"
Now browsing Github you should see two commits with "[maven-release-plugin]" in the label. See examples in Verify local updates On some repositories (like fcrepo/fcrepo) you are not able to push directly on to main, in this case you should push your release branch up to origin
Then open a pull request from the release branch to main, it will have the 2 release related commits. This pull request should NOT be squash merged. -- If you are working on a past version, see Push Release Branch to Maintenance |
You should still have your built Fedora webapp war file. (i.e. fedora-webapp-${CURR}.war) Checkout the tagged version of Fedora and build it.
|
This assumes you fcrepo and fcrepo-docker repositories are checked out as siblings.
/home_directory /fcrepo /fcrepo-docker |
If you don't have a fcrepo-docker repository checked out then run
git clone https://github.com/fcrepo-exts/fcrepo-docker.git |
Change into the fcrepo-docker directory
We want to release with 3 tags for each release.
These tags are provided at the end of command below separated by spaces
|
cd fcrepo-docker DOCKER_PASSWORD=<password> DOCKER_USERNAME=<username> ./build-and-push-to-dockerhub.sh <path to your fcrepo repository>/fcrepo-webapp/target/fcrepo-webapp-${CURR}.war ${TAGS as defined above} |
Locate/build the artifacts
For Fedora core: The WAR file will be in the fcrepo/fcrepo-webapp/target directory. It will have the name fcrepo-webapp-${CURR}.war Copy it to a new location outside of the fcrepo directory, then build the one-click artifact.
This builds an executable JAR file in the fcrepo/fcrepo-webapp/target directory. It will have the name fcrepo-webapp-${CURR}-jetty-console.jar Copy this file beside the WAR file from above. |
For all other projects The JAR file will be in the repository's target directory. |
Next we want to make a SHA-1 and MD5 checksum for the artifact(s).
Note: The checksum files should have lines of the format "[checksum] [filename]" |
|
|
Click the Draft New Release button.
Click Choose a tag and find and select the new release tag.
This is done to update the Github Pages documentation:
mvn site-deploy -DskipTests |
fcrepo pages will be visible at
http://docs.fcrepo.org/site/$CURR/$REPO/
Other module pages will be located at: $ORG.github.io/$REPO/site/$CURR/fcrepo/$REPO
For fcrepo/fcrepo and fcrepo-exts/fcrepo-camel, manually add links to the current releases. The easiest way to do this is to search for an old version number and copy/update for the current release.
|
This is only necessary for past versions of software when a bug fix is being applied. Otherwise you would have updated the project's main branch at the end of Publish on sonatype above.
The release branch has changes made since code freeze. It also contains the update to the version numbers for future development.
git checkout ${CURR}-RC # this is your local copy of the release branch git log |
Ensure that your commit history matches the release branch's commit history, except for the two additional commits.
If this appears correct, you can push your release branch on to the maintenance branch.
git push origin ${CURR}-RC:${CURR}-maintenance |
Hopefully you did this as you went along, but if not review your Fedora release spreadsheet page and ensure you didn't miss anything.
Depending on your comfort you may attack some of these in different ways. (i.e. perform all builds and sonatype releases, then generate all the Github releases last)
Let Arran Griffith and/or Dan Field know that the release is complete and can be announced.