Skip to content

Release.md

Latest commit

 

History

History
21 lines (14 loc) · 2.09 KB

Release.md

File metadata and controls

21 lines (14 loc) · 2.09 KB

GXABM Release Process

The master branch is used for releases and points to the latest tagged commit. The current version number is maintained in abm/VERSION. The dev branch is used for development.

You can use the bin/bump.sh script to update the version number as needed. Run bin/bump.sh --help for more information.

To perform a manual release

To perform a release, follow these steps

  1. Merge the dev branch into master.
    git checkout master
    git merge dev
  2. Update the version number in abm/VERSION.
    bin/bump.sh release
  3. Commit and push the changes to origin master.
    git add abm/VERSION
    git commit -m "Release $(cat abm/VERSION)"
    git push origin master
  4. Use the make command to build and deploy the release.
    make clean build deploy tag
    The deploy goal deploys gxabm to PyPi. The tag goal tags the current commit using the version defined in abm/VERSION and creates a release on GitHub using the bin/tag.sh script.
  5. Switch back to the dev branch and merge the master branch into dev.
    git checkout dev
    git merge master
  6. Update the version number in abm/VERSION to the next dev version and push to origin dev.
    bin/bump.sh [major|minor|patch]
    git add abm/VERSION
    git commit -m "Bump version to $(cat abm/VERSION)"
    git push origin dev
    The [major|minor|patch] parameters specifies which portion of the version number will be incremented.
  7. [Optional] use the bin/move_issues.sh script to move all open issues from the current milestone to the next milestone. For example, to move all issues from the 2.10 milestone to the 2.11 milestone use:
    bin/move_issues.sh --from 2.10 --to 2.11
    If the --to milestone does not exist it will be created.

To perform an automated release

To perform a scripted release you can use the bin/release.sh [major|minor|patch] script. This script will perform all of the above steps. If one of [major|minor|patch] is not specified the minor portion of the version number will be incremented. Run bin/release.sh --help for more information.