Skip to content

Creating A Release

rodrigodesalvobraz edited this page May 20, 2018 · 9 revisions

Setup Required for doing a Release

If you have not done so already, ensure you can deploy to the Maven Central repository from your workspace. See Deploying via Nexus Guide for details.

If you have already gone through this setup in a previous computer and want to do it in a new one, you need to have completed the project setup, and then migrate your GnuPG keys and Maven's settings.xml file (typically in the .m2 directory inside the user's home directory, but also possibly in the conf directory in Maven's home) to the new computer.

Preparing the Release

  1. Checkout the latest version of aic-expresso into a clean workspace.
  2. Ensure all tests pass and there are no compiler warnings.
  3. Ensure the version number is updated in the appropriate places in the relevant pom.xml files (that is, the "Version" field of aic-expresso's pom.xml, and the "Modules" section of pom.xml files of all projects that use aic-expresso). If the current number version ends with -SNAPSHOT, simply remove this part (for example, from "1.3.1-SNAPSHOT" to "1.3.1"), because snapshots are numbered according to the next release number.
  4. Commit changes to GitHub.

Publish the Release

  1. Run the following command from your aic-expresso workspace directory:
    mvn -P sonatype-oss-release deploy
  2. Follow the instructions in the "Releasing to Central" section from the guide for deploying via Nexus.
  3. Tag the release under Git (using git tag -a "<version number>" -m "<message>" -- for example, git tag -a "1.3.1" -m "Releasing demo with improved GUI", or finding repository in Eclipse's EGit, then its Tags, and using context menu option "Create Tag" -- don't forget to push the changes)
  4. Ensure the Wiki Pages relating to usage are updated to take into account any changes to the APIs.
  5. Deploy the demo.
  6. Increment the version number and add -SNAPSHOT back (for example, to "1.3.2-SNAPSHOT") in both aic-expresso's pom.xml and the "Modules" section of the pom.xml files of the projects using aic-expresso.
  7. Commit changes to GitHub.
  8. Update the version number on "Latest Maven Information" snippet on the main page (README.md file).

Useful Resources