Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.15 KB

Contributing

To make contributions to this charm, you'll need a working development setup.

You can create an environment for development with tox:

tox devenv -e integration
source venv/bin/activate

Testing

This project uses tox for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

tox run -e format        # update your code according to linting rules
tox run -e lint          # code style
tox run -e unit          # unit tests
tox run -e integration   # integration tests
tox                      # runs 'format', 'lint', and 'unit' environments

The integration tests require options to be passed via the commandline (see tests/conftest.py) and environment variables OPENSTACK_PASSWORD_AMD64 and OPENSTACK_PASSWORD_ARM64 to be able to deploy the charm and/or upload images to OpenStack.

Build the charm

Build the charm in this git repository using:

charmcraft pack