ReleaseHowTo

Notes on how to Release

1. Update documentation:

   • cd $ATS_SRC_DIR/docs/documentation
   • Build the rst for input_spec: make input_spec
   • Increment input_spec:

     cd source/input_spec
     cp ATSNativeSpec_dev.rst.in ATSNativeSpec_X_Y.rst.in
     cp ATSNativeSpec_dev.rst ATSNativeSpec_X_Y.rst
     git add ATSNativeSpec_X_Y.rst.in ATSNativeSpec_X_Y.rst```
     

   • Increment frontmatter:
     • make sure source/input_spec.rst has the right version numbers
     • update source/conf.py with the right version numbers
     • update title in source/input_spec/ATSNativeSpec_X_Y.rst and source/input_spec/ATSNativeSpec_X_Y.rst.in
   • Build html: make html
   • Check to make sure things look ok: open build/html/index.html. If not, edit source or ATSNativeSpec_dev.rst.in and repeat step 1.
   • deploy: make deploy

2. Cut a branch:

   • git checkout -b ats-X.Y
   • git push --set-upstream origin ats-X.Y

3. Go to github Releases and “draft a new release”

   • Tag = ats-X.Y.Z
   • @target branch = ats-X.Y
   • release name = ATS Release X.Y.Z

4. On master, create a tag amanzi-X.Y-dev

   git tag -a ats-X.{Y+1}-dev -m “tag for development beyond version X.Y”
   git push origin ats-X.{Y+1}-dev