Contribute¶
All contributions are welcome on BeyondTheClouds/enos. For any questions, feature requests, issues please use the GitHub issue tracker.
Install from sources and make them editable¶
Developing with enos requires poetry.
$ git clone https://github.com/BeyondTheClouds/enos.git
$ cd enos
$ poetry install
Then, execute enos from poetry.
$ poetry run enos help
$ poetry run enos deploy
Running the tests¶
$ poetry run tox
Running syntax checker¶
$ poetry run tox -e pep8
Generate the documentation¶
$ poetry run tox -e docs
Release a new version¶
As a pre-requisite, you will have to generate a token on pypi and configure poetry to use it:
$ poetry config pypi-token.pypi XXXXXXX
Before making a new release, make sure that tests and pep8 are happy, and write some appropriate changelog entries.
First, update the version in enos/utils/constants.py
and pyproject.toml
,
and commit the result.
Then, git tag, build a wheel with poetry, and upload it to pypi:
$ git tag v8.0.0a2
$ poetry build
$ poetry publish
$ git push
$ git push --tags
Finally, create a release on github and copy-paste the changelog entries.