Skip to content

Commit 7b493e3

Browse files
authored
Document /poe build slash command.
1 parent e4cbaaf commit 7b493e3

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ The Airbyte CDK uses [Poe the Poet](https://poethepoet.natn.io/) to define commo
3030

3131
Optionally, if you can [pre-install Poe](https://poethepoet.natn.io/installation.html) with `pipx install poethepoet` and then you will be able to run Poe tasks with the shorter `poe TASKNAME` syntax instead of `poetry run poe TASKNAME`.
3232

33+
34+
3335
## Running tests locally
3436

3537
- Iterate on the CDK code locally.
@@ -93,6 +95,8 @@ To generate the documentation, run `poe docs-generate` or to build and open the
9395

9496
The `docs-generate` Poe task is mapped to the `run()` function of `docs/generate.py`. Documentation pages will be generated in the `docs/generated` folder (ignored by git). You can also download auto-generated API docs for any GitHub push by navigating to the "Summary" tab of the docs generation check in GitHub Actions.
9597

98+
Note: in your PR, you can also run this with the slash command: `/poe build`.
99+
96100
## Release Management
97101

98102
Please see the [Release Management](./RELEASES.md) guide for information on how to perform releases and pre-releases.
@@ -113,6 +117,7 @@ Only Airbyte CDK maintainers can run slash commands. The most common slash comma
113117

114118
- `/autofix`- Corrects any linting or formatting issues and commits the change back to the repo.
115119
- `/poetry-lock` - Re-locks dependencies and updates the `poetry.lock` file, then commits the changes back to the repo. This is helpful after merging in updates from main, or when creating a PR in the browser - such as for version bumps or dependency updates directly in the PR.
120+
- `/poe ...` - Runs a Poe task in CI. If files are modified (e.g. as with `/poe build`) , they will be committed back to your branch.
116121

117122
The full list of available slash commands can be found in the [slash command dispatch file](https://github.com/airbytehq/airbyte-python-cdk/blob/main/.github/workflows/slash_command_dispatch.yml#L21-L25).
118123

0 commit comments

Comments
 (0)