Add GitHub Action to welcome new contributors #122
Conversation
|
""" WalkthroughA new GitHub Actions workflow named "Welcome New Contributors" has been added. This workflow automatically posts a welcome message when a user opens their first issue or pull request, using the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub
participant Workflow
participant FirstInteractionAction
User->>GitHub: Open Issue or Pull Request
GitHub->>Workflow: Trigger "Welcome New Contributors"
Workflow->>FirstInteractionAction: Run action with GitHub token
FirstInteractionAction->>GitHub: Post welcome message to Issue/PR
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/workflows/first-interaction.yml (2)
18-19: Remove trailing whitespace to satisfy lintersYAMLlint is already flagging these lines. Strip the spaces at EOL to keep the workflow lint-clean.
- 👋 Hello and welcome! Thank you for opening your first issue.·· + 👋 Hello and welcome! Thank you for opening your first issue. … - 🎉 Thanks for your first pull request!·· + 🎉 Thanks for your first pull request!Also applies to: 22-22
3-7: Consider welcoming users onreopenedPRs / issues as wellEdge-case: a contributor might close and later reopen their first PR/issue, receiving no greeting because the event type is limited to
opened.
If desirable, broaden the trigger:on: issues: types: [opened, reopened] pull_request: types: [opened, reopened]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/first-interaction.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/workflows/first-interaction.yml
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 22-22: trailing spaces
(trailing-spaces)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/first-interaction.yml (2)
17-17: Pin the action to a commit SHA for supply-chain safetyRelying on a mutable tag (
@v1) means the referenced code can change without notice. Pinning to the action’s commit SHA guards against malicious or breaking upstream changes.- uses: actions/first-interaction@v1 + # Pinned for security – update periodically + uses: actions/first-interaction@9e0bbf9a5fdb2b4e2a94b4d7a5da9c927c4e8e34
20-26: Trim trailing whitespace to pass YAML-lint
yamllintflags trailing spaces on lines 21 & 25.- 👋 Hello and welcome! Thank you for opening your first issue.·· + 👋 Hello and welcome! Thank you for opening your first issue. @@ - 🎉 Thanks for your first pull request!·· + 🎉 Thanks for your first pull request!
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/first-interaction.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/workflows/first-interaction.yml
[error] 21-21: trailing spaces
(trailing-spaces)
[error] 25-25: trailing spaces
(trailing-spaces)
🔇 Additional comments (1)
.github/workflows/first-interaction.yml (1)
11-13: 👍 Permissions block added correctlyThe explicit
permissionsblock solves the write-scope problem highlighted in the previous review and should let the workflow post comments successfully.
1 participant
This PR adds a GitHub Actions workflow to welcome users when they open their first issue or pull request. It improves community experience for first-time contributors.
Fixes #100
Summary by CodeRabbit