k2bd / gh-webhooks-test

Test of the gh-webhooks package

Developing

Install Poetry and poetry install the project

Useful Commands

Note: if Poetry is managing a virtual environment for you, you may need to use poetry run poe instead of poe

• poe autoformat - Autoformat code
• poe lint - Linting
• poe test - Run Tests
• poe local-server - Run your API locally

While the local server is running, you can see API docs at http://localhost:8011/docs or http://localhost:8011/redoc, and can get the OpenAPI spec at http://localhost:8011/openapi.json.

Deployment

Release a new version by manually running the release action on GitHub with a 'major', 'minor', or 'patch' version bump selected. This will create an push a new semver tag of the format v1.2.3, and also update the appropriate major version tag (v1, v2, ...).

Updating the major version tags will cause Cloud Build to create or update that version's deployment automatically and host it at e.g. v1.(your configured domain). You may need to configure your domain's DNS if you're creating an endpoint for a new major version and you use an external provider. See the domain mappings page linked here for instructions.