Skip to content

Managing Releases

Consider impact on plugins

If this release will impact the functionality of current plugins, make sure to either update all plugins when this release is made, or communicate the need to update plugins.

Making a new release

  • Make sure you're on the main branch, and you've pulled all recently merged changes: git pull origin main
  • Bump the version number in pyproject.toml
  • Make an entry in changelog.md
  • Commit this change: git commit -am "Bumped version number, and updated changelog."
  • Push this change directly to main: git push origin main
  • Delete everything in dist/: rm -rf dist/
  • Run python -m build, which recreates dist/

  • Tag the new release:

    • $ git tag vA.B.C
    • $ git push origin vA.B.C

  • Push to PyPI: 

    (venv)$ python -m twine upload dist/*

  • View on PyPI: https://pypi.org/project/django-simple-deploy/

  • Test the released package: 

    $ pytest tests/e2e_tests --plugin <plugin-name> --pypi -s

    • Sometimes there's a stale cache that causes the previous release to be installed. If you don't check this version, you won't know whether the new release actually works. In the test output, verify that the new version was installed. Look for something like this:
$ pytest tests/e2e_tests --plugin dsd_flyio --pypi -s
Temp project directory: ...
...
Collecting django-simple-deploy
  Downloading django_simple_deploy-0.6.2-py3-none-any.whl.metadata
...
Successfully installed Django-5.0.6 ... django-simple-deploy-0.6.2 ...
...

Deleting branches

Delete the remote and local development branches:

$ git push origin -d feature_branch
$ git branch -d feature_branch

Deleting tags

If needed:

$ git tag -d vA.B.C

Verifying dist/

To make sure the right files are included in wheels, using the Fly plugin as an example:

$ pip install wheel
$ wheel unpack dist/dsd_flyio-0.9.0-py3-none-any.whl
$ ls dsd_flyio-0.9.0/dsd_flyio/templates