Skip to content

RELEASE.md

Latest commit

 

History

History
38 lines (31 loc) · 1.84 KB

RELEASE.md

File metadata and controls

38 lines (31 loc) · 1.84 KB

Creating a mvnmin release

This section provides instruction on how to create and new mvnmin release.

NOTE: This guide assumes you are somewhat familiar with the maven-release-plugin and its typical flow: https://maven.apache.org/guides/mini/guide-releasing.html

Pre-conditions:

The following must be true before starting this process:

  • You have no outstanding changes in your local repository
  • All changes have been pushed remotely
  • You are authenticated with the remote git repository and able to push changes

Process

  1. Update the version numbers in the README.md installation instructions to match the new release number. This sed script shows updating from 1.0.1 to 1.0.2.

    sed -ibak 's/1\.0\.1/1.0.2/g'  README.md

  2. Invoke the command below, and answer the questions regarding versions, typically the defaults can be accepted.This will update the pom with a new version number and create a tag in git.

    mvn release:prepare

  3. Now create the release version. We skip deployment as we don't have a place to automatically deploy binaries, yet.

    mvn release:perform -Darguments="-Dmaven.deploy.skip=true  -Dmaven.site.skip=true -Dmaven.site.deploy.skip=true"

  4. Visit the github releases page :

    1. Follow this link https://github.com/elasticpath/mvnmin/releases
    2. Press the Draft a new release button
    3. Select the tag you just created above for the Tag version
    4. Use the tag name for the Release title field
    5. Add release notes as needed
    6. Upload the zip binary from the previous step. You will find the jar in the project's target/checkout/target/ folder.
    7. Tick the This is a pre-release checkbox (until we hit version 1.0.0)
    8. Check your work, and then hit Publish release

    note: it is possible to edit a release after publishing.