From 7b493e39f0df2b73f7e81fa3b100ba63aa13011e Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Wed, 30 Jul 2025 13:34:51 -0700 Subject: [PATCH 1/6] Document `/poe build` slash command. --- docs/CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 26bfb84b5..2b7332457 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -30,6 +30,8 @@ The Airbyte CDK uses [Poe the Poet](https://poethepoet.natn.io/) to define commo 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`. + + ## Running tests locally - Iterate on the CDK code locally. @@ -93,6 +95,8 @@ To generate the documentation, run `poe docs-generate` or to build and open the 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. +Note: in your PR, you can also run this with the slash command: `/poe build`. + ## Release Management 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 - `/autofix`- Corrects any linting or formatting issues and commits the change back to the repo. - `/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. +- `/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. 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). From d7cd69a61f095fffc140d658a8b6a0e9db54584a Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Wed, 30 Jul 2025 13:48:58 -0700 Subject: [PATCH 2/6] Update pr-welcome-internal.md --- .github/pr-welcome-internal.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pr-welcome-internal.md b/.github/pr-welcome-internal.md index 65986d4c7..2cc930f89 100644 --- a/.github/pr-welcome-internal.md +++ b/.github/pr-welcome-internal.md @@ -26,6 +26,7 @@ Airbyte Maintainers can execute the following slash commands on your PR: - `/autofix` - Fixes most formatting and linting issues - `/poetry-lock` - Updates poetry.lock file - `/test` - Runs connector tests with the updated CDK +- `/poe build` - Regenerate git-committed build artifacts, such as the source declarative manifest JSON schema in YAML. - `/poe ` - Runs any poe command in the CDK environment [📝 _Edit this welcome message._](https://github.com/airbytehq/airbyte-python-cdk/blob/main/.github/pr-welcome-internal.md) From 1f22be910bcd75248a92da57aeae7cf1a87a582e Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Tue, 5 Aug 2025 15:41:38 -0700 Subject: [PATCH 3/6] Update .github/pr-welcome-internal.md --- .github/pr-welcome-internal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pr-welcome-internal.md b/.github/pr-welcome-internal.md index 2cc930f89..0f4aa6e2c 100644 --- a/.github/pr-welcome-internal.md +++ b/.github/pr-welcome-internal.md @@ -26,7 +26,7 @@ Airbyte Maintainers can execute the following slash commands on your PR: - `/autofix` - Fixes most formatting and linting issues - `/poetry-lock` - Updates poetry.lock file - `/test` - Runs connector tests with the updated CDK -- `/poe build` - Regenerate git-committed build artifacts, such as the source declarative manifest JSON schema in YAML. +- `/poe build` - Regenerate git-committed build artifacts, such as the pydantic models which are generated from the manifest JSON schema in YAML. - `/poe ` - Runs any poe command in the CDK environment [📝 _Edit this welcome message._](https://github.com/airbytehq/airbyte-python-cdk/blob/main/.github/pr-welcome-internal.md) From 61d96f5e03c0caf38a2952c92ab0d975cf8a13d7 Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Tue, 5 Aug 2025 15:42:09 -0700 Subject: [PATCH 4/6] Update docs/CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2b7332457..290213fb4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -95,8 +95,6 @@ To generate the documentation, run `poe docs-generate` or to build and open the 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. -Note: in your PR, you can also run this with the slash command: `/poe build`. - ## Release Management Please see the [Release Management](./RELEASES.md) guide for information on how to perform releases and pre-releases. From 8628517c0e78748ae4ece072c2c281ac9026ca99 Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Tue, 5 Aug 2025 15:42:33 -0700 Subject: [PATCH 5/6] Update docs/CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 290213fb4..0d9700cb5 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -30,8 +30,6 @@ The Airbyte CDK uses [Poe the Poet](https://poethepoet.natn.io/) to define commo 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`. - - ## Running tests locally - Iterate on the CDK code locally. From e244a5efd31554b12d4054807c18e23631e0777c Mon Sep 17 00:00:00 2001 From: "Aaron (\"AJ\") Steers" Date: Tue, 5 Aug 2025 15:43:24 -0700 Subject: [PATCH 6/6] Update docs/CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0d9700cb5..bb7dc9b2c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -113,7 +113,7 @@ Only Airbyte CDK maintainers can run slash commands. The most common slash comma - `/autofix`- Corrects any linting or formatting issues and commits the change back to the repo. - `/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. -- `/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. +- `/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. 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).