CONTRIBUTING.md

Contributing

Development environment

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 static        # static type checking
tox run -e unit          # unit tests
tox run -e scenario      # scenario tests
tox run -e integration   # integration tests
tox                      # runs 'format', 'lint', 'static', 'unit', 'scenario', and 'integration' environments

Build the charm

Build the charm in this git repository using:

charmcraft pack

Updating the Gateway API CRD manifests

The Gateway API manifests are vendored into this charm. We use the most recent stable release. To update these manifests, run:

RELEASE=v1.1.0
wget https://github.com/kubernetes-sigs/gateway-api/releases/download/${RELEASE}/standard-install.yaml -O ./src/manifests/gateway-apis-crds.yaml