File tree Expand file tree Collapse file tree 3 files changed +109
-0
lines changed Expand file tree Collapse file tree 3 files changed +109
-0
lines changed Original file line number Diff line number Diff line change 1+ ## 👋 Welcome to the Airbyte Python CDK!
2+
3+ Thank you for your contribution from ** {{ .repo_name }}** ! We're excited to have you in the Airbyte community.
4+
5+ ### Testing This CDK Version
6+
7+ You can test this version of the CDK using the following:
8+
9+ ``` bash
10+ # Run the CLI from this branch:
11+ uvx ' git+https://github.com/airbytehq/airbyte-python-cdk.git@{{ .branch_name }}#egg=airbyte-python-cdk[dev]' --help
12+
13+ # Update a connector to use the CDK from this branch ref:
14+ cd airbyte-integrations/connectors/source-example
15+ poe use-cdk-branch {{ .branch_name }}
16+ ```
17+
18+ ### Helpful Resources
19+
20+ - [ Contributing Guidelines] ( https://docs.airbyte.com/contributing-to-airbyte/ )
21+ - [ CDK API Reference] ( https://airbytehq.github.io/airbyte-python-cdk/ )
22+
23+ ### PR Slash Commands
24+
25+ As needed or by request, Airbyte Maintainers can execute the following slash commands on your PR:
26+
27+ - ` /autofix ` - Fixes most formatting and linting issues
28+ - ` /poetry-lock ` - Updates poetry.lock file
29+ - ` /test ` - Runs connector tests with the updated CDK
30+
31+ If you have any questions, feel free to ask in the PR comments or join our [ Slack community] ( https://airbytehq.slack.com/ ) .
32+
Original file line number Diff line number Diff line change 1+ ## 👋 Greetings, Airbyte Team Member!
2+
3+ Here are some helpful tips and reminders for your convenience.
4+
5+ ### Testing This CDK Version
6+
7+ You can test this version of the CDK using the following:
8+
9+ ``` bash
10+ # Run the CLI from this branch:
11+ uvx ' git+https://github.com/airbytehq/airbyte-python-cdk.git@{{ .branch_name }}#egg=airbyte-python-cdk[dev]' --help
12+
13+ # Update a connector to use the CDK from this branch ref:
14+ cd airbyte-integrations/connectors/source-example
15+ poe use-cdk-branch {{ .branch_name }}
16+ ```
17+
18+ ### Helpful Resources
19+
20+ - [ CDK API Reference] ( https://airbytehq.github.io/airbyte-python-cdk/ )
21+
22+ ### PR Slash Commands
23+
24+ Airbyte Maintainers can execute the following slash commands on your PR:
25+
26+ - ` /autofix ` - Fixes most formatting and linting issues
27+ - ` /poetry-lock ` - Updates poetry.lock file
28+ - ` /test ` - Runs connector tests with the updated CDK
29+ - ` /poe <command> ` - Runs any poe command in the CDK environment
30+
31+ [ 📝 _ Edit this welcome message._ ] ( https://github.com/airbytehq/airbyte-python-cdk/blob/main/.github/pr-welcome-internal.md )
Original file line number Diff line number Diff line change 1+ name : Community PR Welcome Message
2+
3+ # This workflow automatically adds a welcome message to PRs from community contributors (forks)
4+ # It includes CDK usage instructions and other helpful resources for testing changes
5+ #
6+ # MANUAL TESTING INSTRUCTIONS:
7+ # To manually test this workflow, temporarily uncomment the "synchronize" event type as a workflow trigger.
8+ # Then the workflow will run for all new commits.
9+ #
10+ # Before merging, remember to again comment-out the "synchronize" clause and uncomment the `if:` condition.
11+
12+ on :
13+ pull_request :
14+ types :
15+ - opened
16+ - reopened
17+ # Toggle this line, uncommenting for testing:
18+ # - synchronize
19+
20+ jobs :
21+ welcome-contributor :
22+ name : PR Welcome Message
23+ permissions :
24+ contents : read
25+ issues : write
26+ pull-requests : write
27+ runs-on : ubuntu-24.04
28+ steps :
29+ - name : Checkout repository
30+ uses : actions/checkout@v4
31+
32+ - name : Render template
33+ id : template
34+ uses : chuhlomin/render-template@v1.4
35+ with :
36+ # Use a different template for internal vs forks (community)
37+ template : ${{ github.event.pull_request.head.repo.fork == true && '.github/pr-welcome-community.md' || '.github/pr-welcome-internal.md' }}
38+ vars : |
39+ repo_name: ${{ github.event.pull_request.head.repo.full_name }}
40+ branch_name: ${{ github.event.pull_request.head.ref }}
41+
42+ - name : Create comment
43+ uses : peter-evans/create-or-update-comment@v4
44+ with :
45+ issue-number : ${{ github.event.pull_request.number }}
46+ body : ${{ steps.template.outputs.result }}
You can’t perform that action at this time.
0 commit comments