Skip to content

Home

Jump to bottom
P. L. Lim edited this page Jul 31, 2020 · 15 revisions

Where to release

  • GitHub
  • PyPI (bot picks up from GitHub release)
  • conda-forge (bot picks up from PyPI)
  • astroconda
  • Zenodo

How to release on GitHub

There are some old release branches but this package is low-traffic enough that we stopped using release branches.

  1. Grab latest code from master
  2. Grab all the tags from this repo
  3. Make sure you are on the branch that you intend to release from
  4. Check git status (must be clean) and git log (must contain correct history)
  5. Finalize release date on change log, add, and commit it.
  6. git clean -xdf
  7. git tag -s "X.Y.Z" -m "Tagging version X.Y.Z" (replace X.Y.Z with real version number)
  8. git push <remote> X.Y.Z (replace <remote> with remote name that points to this repo)
  9. Add new change log entry for next release, add, and commit it.
  10. git push <remote> master
  11. git checkout stable
  12. git reset --hard <version>
  13. git push <remote> stable --force
  14. Edit release tag on GitHub to add change log and publish release.

How to release on PyPI

Check the logs under Actions. This should be done automatically when a GitHub Release is made. If successful, you will see it on https://pypi.org/project/synphot/ .

Other release outlets

  • Open a PR on astroconda/astroconda-contrib to update recipe. Usually this is done together with stsynphot.
  • Wait for a notification from conda-forge feedstock, review its PR, fix (if needed), and merge.
  • Download the release tarball from PyPI and upload it to Zenodo.
  • Check https://readthedocs.org/projects/synphot/builds/
Clone this wiki locally