Release Process

Review release candidate

Once all changes have been merged to master, check the following on the master branch:

• The documentation version (in conf.py) should match the version to be released.
• Confirm that https://asdf-standard.readthedocs.io/en/latest has been generated from latest master, and click through the pages to double-check the rendering (with particular attention to math expressions in auto-generated schema documentation).
• Confirm that the Travis build is passing.

Update the asdf library's submodule pointer and run tests

Update the asdf library's submodule pointer to asdf-standard's latest master, and run the following test suites with the modified asdf library installed:

• asdf
• astropy
• jwst unit tests
• jwst regression tests
• specutils
• gwcs

Create the release tag

If the tests all pass, then we're ready to tag. Historically there have not been any patch releases to the ASDF Standard, so we're not going to bother with a release branch.

1. Create an annotated tag with a name that matches the intended release:

$ git tag -a a.b.c -m "Tagging a.b.c release"

2. Push the new tag to the upstream remote:

$ git push upstream a.b.c

Maintain the stable branch

The stable branch points to the latest official release of the ASDF Standard. We'll need to rewrite the stable branch to point to our new tag.

$ git checkout stable
$ git reset --hard a.b.c
$ git push upstream stable --force

Prepare master for further development

1. Make a copy of the version_map-a.b.c.yaml file for the next version (x.y.z).

2. Update the documentation conf.py to reflect version x.y.z.

3. Commit these changes.

Confirm successful readthedocs build

New tags on the repository should provoke a readthedocs build that automatically activates and builds the new version, and sets those new docs as the default. Confirm that the asdf-standard readthedocs home shows docs for the version just released.