Development¶
Contribution Guideline¶
This is a Jazzband project. By contributing you agree to abide by the Contributor Code of Conduct and follow the guidelines.
Setup development environment¶
Requires supported Python version
do setup under django-redshift-backend.git repository root as:
$ pip install -U pip setuptools $ pip install -r dev-requires.txt
Testing¶
Run test¶
Just run tox:
$ tox
tox have several sections for testing.
To test the database migration as well, start postgres and test it as follows:
$ cd tests
$ docker-compose up -d
$ TEST_WITH_POSTGRES=1 tox
CI (Continuous Integration)¶
All tests will be run on Github Actions:
Releasing¶
New package version¶
The django-redshift-backend package will be uploaded to PyPI: https://pypi.org/project/django-redshift-backend/.
Here is a release procefure for releasing.
Procedure:
- check CI status testing result: https://github.com/jazzband/django-redshift-backend/actions?query=workflow%3ATest
- update release version/date in
CHANGES.rst
- create Github release, tagging with version name that MUST following semver. e.g.:
git tag 1.0.1
- publish Github release to invoke release process in Github Actions.
- approve release files. please check your email or https://jazzband.co/projects/django-redshift-backend
- check PyPI page: https://pypi.org/p/django-redshift-backend
- bump version in
CHANGES.rst
and commit/push them onto GitHub
Updated documentation¶
Sphinx documentation under doc/
directory on the master branch will be automatically uploaded into ReadTheDocs: https://django-redshift-backend.rtfd.io/.