Skip to content

Commit 661db91

Browse files
feat: Add PR welcome message system with uvx installation examples (#721)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: AJ Steers <aj@airbyte.io>
1 parent a31830c commit 661db91

3 files changed

Lines changed: 115 additions & 0 deletions

File tree

.github/pr-welcome-community.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## 👋 Welcome to PyAirbyte!
2+
3+
Thank you for your contribution from **{{ .repo_name }}**! We're excited to have you in the Airbyte community.
4+
5+
### Testing This PyAirbyte Version
6+
7+
You can test this version of PyAirbyte using the following:
8+
9+
```bash
10+
# Run PyAirbyte CLI from this branch:
11+
uvx --from 'git+https://github.com/{{ .repo_name }}.git@{{ .branch_name }}' pyairbyte --help
12+
13+
# Install PyAirbyte from this branch for development:
14+
pip install 'git+https://github.com/{{ .repo_name }}.git@{{ .branch_name }}'
15+
```
16+
17+
### Helpful Resources
18+
19+
- [Contributing Guidelines](https://github.com/airbytehq/PyAirbyte/blob/main/docs/CONTRIBUTING.md)
20+
- [PyAirbyte Documentation](https://docs.airbyte.com/using-airbyte/pyairbyte/getting-started)
21+
- [API Reference](https://airbytehq.github.io/PyAirbyte/)
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+
- `/fix-pr` - Fixes most formatting and linting issues
28+
- `/poetry-lock` - Updates poetry.lock file
29+
- `/test-pr` - Runs tests with the updated PyAirbyte
30+
31+
### Community Support
32+
33+
If you have any questions, feel free to ask in the PR comments or join our community:
34+
- [Airbyte Slack](https://airbytehq.slack.com/) - Join the [#pyairbyte channel](https://airbytehq.slack.com/archives/C06FZ238P8W)
35+
- [GitHub Discussions](https://github.com/airbytehq/PyAirbyte/discussions)

.github/pr-welcome-internal.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## 👋 Greetings, Airbyte Team Member!
2+
3+
Here are some helpful tips and reminders for your convenience.
4+
5+
### Testing This PyAirbyte Version
6+
7+
You can test this version of PyAirbyte using the following:
8+
9+
```bash
10+
# Run PyAirbyte CLI from this branch:
11+
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@{{ .branch_name }}' pyairbyte --help
12+
13+
# Install PyAirbyte from this branch for development:
14+
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@{{ .branch_name }}'
15+
```
16+
17+
### Helpful Resources
18+
19+
- [PyAirbyte Documentation](https://docs.airbyte.com/using-airbyte/pyairbyte/getting-started)
20+
- [API Reference](https://airbytehq.github.io/PyAirbyte/)
21+
22+
### PR Slash Commands
23+
24+
Airbyte Maintainers can execute the following slash commands on your PR:
25+
26+
- `/fix-pr` - Fixes most formatting and linting issues
27+
- `/poetry-lock` - Updates poetry.lock file
28+
- `/test-pr` - Runs tests with the updated PyAirbyte
29+
30+
### Community Support
31+
32+
Questions? Join the [#pyairbyte channel](https://airbytehq.slack.com/archives/C06FZ238P8W) in our Slack workspace.
33+
34+
[📝 _Edit this welcome message._](https://github.com/airbytehq/PyAirbyte/blob/main/.github/pr-welcome-internal.md)
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Community PR Welcome Message
2+
3+
# This workflow automatically adds a welcome message to PRs from community contributors (forks)
4+
# It includes PyAirbyte 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 }}

0 commit comments

Comments
 (0)