Skip to content

Do a new release

Jump to bottom
Wolfgang Kaltz edited this page Feb 25, 2019 · 18 revisions

Doing a new release

Quality check

  • Be sure to be working on master branch, and do git pull
  • Check release number: Edit setup.py -> check version number is target number
  • If a new number is needed, choose a version number. To see which version was previously publishedbeen used, do pip search pyramid_oereb (or check on pypi.org). To see all versions that have been previously published, use the following trick: pip install pyramid_oereb==999
  • Delete all local docker images and do a make clean-all
  • Do a make serve locally and check that json, xml and pdf generation are functional: ** http://localhost:6543/oereb/extract/reduced/xml/CH113928077734 ** http://localhost:6543/oereb/extract/reduced/json/CH113928077734 ** http://localhost:6543/oereb/extract/reduced/pdf/CH113928077734
  • Update migration notes (file doc/source/changes.rst), if applicable, and edit the changelog (file CHANGES.rst)
  • Do a make doc, and check quality of doc (in local browser)
  • Do a make checks
  • Commit doc changes; you can push them right away, unless you are unsure about some points, in which case you can go through the normal pull request process.

Set a version tag

  • Check that you are on master branch and up-to-date.
  • Choose a version number, beginning with “v” (for example v1.4.0) to be consistent with previous releases
  • do git tag <version_number>; git push origin <version_number>
  • Check that this tag setting triggers a release by Travis CI, ** On pypi ** On hub.docker.com/camptocamp/pyramid_oereb

Increment version number in source

  • Edit setup.py to increment version number (for new daily builds) and push right away, so that next daily builds have higher number

GitHub release notes

Set release notes in GitHub user interface

Community communication

If CI is clean and release is present on both platforms (pypi and dockerhub), communicate to the community -> this is handled via Clemens, send him an e-mail to inform him when everything OK

Troubleshooting

  • If you need to re-do everything, delete the tag by doing git tag -d <version-number>; git push origin :refs/tags/<version-number>
  • When re-doing things, careful, as it may trigger actually useless/confusing Travis CI jobs -> stop them manually, and keep only the one coming from the tag setting
Clone this wiki locally