docs: Document /poe build slash command.

[aaronsteers]

Important

Auto-merge enabled.

This PR is set to merge automatically when all requirements are met.

Summary by CodeRabbit

• Documentation
  • Added information about the new /poe GitHub slash command for maintainers, including details on running Poe tasks in CI and automated committing of changes.
  • Updated documentation to include the /poe build command for regenerating build artifacts.

[github-actions]

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Testing This CDK Version

You can test this version of the CDK using the following:

# Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/airbyte-python-cdk.git@aj/docs/poe-build-slash-command#egg=airbyte-python-cdk[dev]' --help

# Update a connector to use the CDK from this branch ref:
cd airbyte-integrations/connectors/source-example
poe use-cdk-branch aj/docs/poe-build-slash-command

Helpful Resources

• CDK API Reference

PR Slash Commands

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 <command> - Runs any poe command in the CDK environment

📝 Edit this welcome message.

[github-actions]

PyTest Results (Fast)

3 694 tests  +5   3 683 ✅ +5   6m 31s ⏱️ -3s
    1 suites ±0      11 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit e244a5e. ± Comparison against base commit e4cbaaf.

This pull request removes 5 and adds 10 tests. Note that renamed tests count towards both.

unit_tests.sources.declarative.requesters.paginators.test_default_paginator ‑ test_path_with_additional_interpolation_context
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced[no_cursor]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced[with_cursor_field_higher_than_range]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced[with_cursor_field_inside_range]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced[with_cursor_field_lower_than_range]

unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_partitioned_state_with_multiple_slices_when_should_be_synced_then_use_upper_boundary_of_first_slice_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_partitioned_state_with_one_slice_and_most_recent_cursor_value_when_should_be_synced_then_use_most_recent_cursor_value_of_slice_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_partitioned_state_with_one_slice_without_most_recent_cursor_value_when_should_be_synced_then_use_upper_boundary_of_slice_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_partitioned_state_without_slices_but_start_when_should_be_synced_then_use_start_value_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_partitioned_state_without_slices_nor_start_when_should_be_synced_then_use_zero_value_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_given_state_when_should_be_synced_then_use_cursor_value_to_filter
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced_non_partitioned_state_no_state[no_cursor]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced_non_partitioned_state_no_state[with_cursor_field_higher_than_end]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced_non_partitioned_state_no_state[with_cursor_field_inside_range]
unit_tests.sources.streams.concurrent.test_cursor ‑ test_should_be_synced_non_partitioned_state_no_state[with_cursor_field_lower_than_start]

♻️ This comment has been updated with latest results.

[Copilot]

Pull Request Overview

This PR documents the /poe slash command functionality for Airbyte CDK maintainers, specifically highlighting the /poe build command for regenerating build artifacts.

• Documents the general /poe ... slash command in the contributing guide
• Adds specific documentation for /poe build command in the PR welcome message

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
docs/CONTRIBUTING.md	Adds documentation for the general /poe ... slash command with auto-commit behavior
.github/pr-welcome-internal.md	Adds specific /poe build command documentation with use case example

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

This change updates documentation to include the new /poe build slash command for Airbyte maintainers. The command is now described in both the internal PR guide and the public contributing guide, clarifying its purpose and behavior regarding regenerating and committing build artifacts.

Changes

Cohort / File(s)	Change Summary
Internal PR Guide Update .github/pr-welcome-internal.md	Documents the new /poe build slash command for maintainers, specifying its purpose and usage.
Contributor Documentation Update docs/CONTRIBUTING.md	Adds /poe ... (including /poe build) to the list of available slash commands, with usage details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• ci: add /poe slash command for CDK PRs and Issues #505: Introduces the foundational /poe slash command infrastructure, which the current PR extends by documenting /poe build. Wdyt about reviewing both together for consistency?

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch aj/docs/poe-build-slash-command

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.github/pr-welcome-internal.md (1)

29-29: Consider tightening the wording for extra clarity

How about re-phrasing to something like:

“/poe build – Regenerates git-committed build artifacts (e.g., the Pydantic models generated from the manifest JSON schema defined in YAML).”

This trims a few words, capitalises Pydantic, and parenthesises the example so it reads a bit smoother—wdyt?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4cbaaf and e244a5e.

📒 Files selected for processing (2)

• .github/pr-welcome-internal.md (1 hunks)
• docs/CONTRIBUTING.md (1 hunks)

🧰 Additional context used

🧠 Learnings (7)

📚 Learning: the files in `airbyte_cdk/cli/source_declarative_manifest/`, including `_run.py`, are imported from ...

Learnt from: aaronsteers
PR: airbytehq/airbyte-python-cdk#58
File: airbyte_cdk/cli/source_declarative_manifest/_run.py:62-65
Timestamp: 2024-11-15T01:04:21.272Z
Learning: The files in `airbyte_cdk/cli/source_declarative_manifest/`, including `_run.py`, are imported from another repository, and changes to these files should be minimized or avoided when possible to maintain consistency.

Applied to files:

• docs/CONTRIBUTING.md
• .github/pr-welcome-internal.md

📚 Learning: when code in `airbyte_cdk/cli/source_declarative_manifest/` is being imported from another repositor...

Learnt from: aaronsteers
PR: airbytehq/airbyte-python-cdk#58
File: airbyte_cdk/cli/source_declarative_manifest/spec.json:9-15
Timestamp: 2024-11-15T00:59:08.154Z
Learning: When code in `airbyte_cdk/cli/source_declarative_manifest/` is being imported from another repository, avoid suggesting modifications to it during the import process.

Applied to files:

• docs/CONTRIBUTING.md

📚 Learning: when a pr's goal is to run the autoformat task from `ruff`, avoid suggesting code changes beyond for...

Learnt from: aaronsteers
PR: airbytehq/airbyte-python-cdk#13
File: airbyte_cdk/connector.py:99-99
Timestamp: 2024-11-10T04:50:11.914Z
Learning: When a PR's goal is to run the autoformat task from `ruff`, avoid suggesting code changes beyond formatting to prevent potential negative side effects.

Applied to files:

• docs/CONTRIBUTING.md

📚 Learning: in poe the poet tasks defined in `pyproject.toml`, setting `ignore_fail = "return_non_zero"` allows ...

Learnt from: aaronsteers
PR: airbytehq/airbyte-python-cdk#2
File: pyproject.toml:113-117
Timestamp: 2024-11-10T03:28:33.676Z
Learning: In Poe the Poet tasks defined in `pyproject.toml`, setting `ignore_fail = "return_non_zero"` allows all tasks in a sequence to run, while still returning a non-zero exit code if any task fails.

Applied to files:

• docs/CONTRIBUTING.md

📚 Learning: in the airbytehq/airbyte-python-cdk repository, ignore all `__init__.py` files when providing a reco...

Learnt from: pnilan
PR: airbytehq/airbyte-python-cdk#0
File: :0-0
Timestamp: 2024-12-11T16:34:46.319Z
Learning: In the airbytehq/airbyte-python-cdk repository, ignore all `__init__.py` files when providing a recommended reviewing order.

Applied to files:

• .github/pr-welcome-internal.md

📚 Learning: in the project, the `run` function is defined in `airbyte_cdk/cli/source_declarative_manifest/_run.p...

Learnt from: aaronsteers
PR: airbytehq/airbyte-python-cdk#58
File: pyproject.toml:108-111
Timestamp: 2024-11-15T00:58:15.446Z
Learning: In the project, the `run` function is defined in `airbyte_cdk/cli/source_declarative_manifest/_run.py` and is imported into the module's `__init__.py`.

Applied to files:

• .github/pr-welcome-internal.md

📚 Learning: in the airbytehq/airbyte-python-cdk repository, the `declarative_component_schema.py` file is auto-g...

Learnt from: pnilan
PR: airbytehq/airbyte-python-cdk#0
File: :0-0
Timestamp: 2024-12-11T16:34:46.319Z
Learning: In the airbytehq/airbyte-python-cdk repository, the `declarative_component_schema.py` file is auto-generated from `declarative_component_schema.yaml` and should be ignored in the recommended reviewing order.

Applied to files:

• .github/pr-welcome-internal.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Pytest (Fast)
• GitHub Check: SDM Docker Image Build

🔇 Additional comments (1)

docs/CONTRIBUTING.md (1)

116-116: LGTM – nicely integrated into the slash-command list

The description is clear and matches the behaviour documented elsewhere.