Skip to content
James R. Perkins edited this page Sep 24, 2024 · 1 revision

Release Procedure:

  1. Check the queue for any PR’s that seem like that might be important for the release and review/merge them.

  2. Ensure you’ve got a fresh environment.

    git fetch upstream
    git reset --hard upstream/${branch}
  3. Do a build locally to make sure all is working as expected. Note, you should define the -Dmaven.repo.local= property and point it to a clean local maven repostory.

    mvn clean install -DskipTests -Pjboss-release -Dmaven.repo.local=/tmp/m2/repository
  4. If successful, update the version to the next release. The simplest way to do this is in your IDE. Note though you should likely do a mvn clean -Prelease first to not update things in the target directory.

  5. git diff to see the diff and make sure it looks okay.

  6. Again do a build to make sure everything builds

    mvn clean install -DskipTests -Pjboss-release -Dmaven.repo.local=/tmp/m2/repository
  7. If everything looks okay, commit the changes

    git commit -s -S -a -m "Prepare for ${newVersion} release"
  8. Next we need to merge the commit in the branch we’re releasing on.

    git checkout $branch
    git merge --ff-only $releaseBranch
  9. Do one more build from the releasing branch, e.g. main in or another version branch. This will build the documentation we need.

    mvn clean install -DskipTests -Pjboss-release -Dmaven.repo.local=/tmp/m2/repository
  10. We can now deploy to JBoss Nexus

    mvn deploy -DskipTests -Pjboss-release -Dmaven.repo.local=$HOME/tmp/m2/repository
  11. Log into the Nexus, validate the release looks okay and close the repository.

  12. Create a tag for the new release

    git tag ${newVersion}
  13. At this stage your Nexus repository should be ready to be relased. Release the repository.

  14. Update the release version to the next SNAPSHOT version, ${nextVersion}.

  15. Run the same steps to check that changes and commit the new release. The commit text should be something like "Next is ${nextVersion}".

  16. Push the tag and branch up to GitHub

    git push upstream --tags

Update JIRA

Finally, JIRA should be updated. The new version needs to be added and the released version needs to be set as released.

Clone this wiki locally