Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.23 KB

DEPLOY.md

File metadata and controls

48 lines (31 loc) · 1.23 KB

Deployment of Inelastica

This document describes the deployment details to perform a version release.

Version release

The release cycle should be performed like this:

  1. Increment the release numbers in the top-directory setup.py script:

     MAJOR
     MINOR
     MICRO
    

    The complete tag is VERSION = "v[MAJOR].[MINOR].[MICRO]".

  2. Set the variable GIT_REVISION to the latest commit in the top-directory setup.py. This means that the revision specification for the release actually corresponds to the commit just before the actual release. You can get the commit hash by:

     git rev-parse HEAD
     GIT_REVISION = <git rev-parse HEAD>
    
  3. Commit changes:

     git add setup.py
     git commit -m "Release [VERSION]"
    

    with the corresponding version number.

  4. Tag the commit with:

     git tag -a "[VERSION]" -m "Releasing [VERSION]"
    

    Include a complete description of the essential code modifications since last release.

  5. Merge master branch into gh-pages and update html documentation:

     git checkout gh-pages
     git merge master
     cd docs
     ./run.sh
     git add latest
     git commit -m "docs: update html"