Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.79 KB

release_checklist.md

File metadata and controls

59 lines (39 loc) · 1.79 KB
Raw

Things to do in order to cut a new release

Passing Tests

Make sure that all of the tests on travis-ci have run and are passing.

Bump the version

Editing jobtastic/__init__.py and increment the version according to the Semantic Versioning standard.

Changelog

Ensure that the CHANGELOG.rst file includes all relevant changes.

Documentation is up to date

Ensure that any new features are documented and give the docs a read-through to make sure they haven't started lying.

Publish documentation

We currently use Github Pages as both the project home page and the place for online documentation.

  1. Visit the automatic page generator.
  2. Click Load README.md to update the content.
  3. Click Continue to Layouts
  4. Select the "Leap Day" theme and scan to make sure it looks good.
  5. Click Publish.

Build and push the package to PyPi

  1. Run $ python setup.py sdist to make sure the package is kosher. Correct any errors or warnings that appear and commit those changes.
  2. Check the package file to ensure that it has the files we want.
  3. Push to PyPi! $ python setup.py sdist upload

Tag the version

Use git to tag the version according to theSemantic Versioning standard.

eg. $ git tag v0.1.1 && git push --tags

Post the Changelog to the Github releases page

Browse to the releases page and edit our newly-tagged release with a title and the relevant Changelog sections.

Consider announcing things

If the new version adds something sufficiently cool, consider posting to the celery mailing list. Also consider posting to G+, Twitter, etc. so that folks who would find Jobtastic useful can actually find it.