feat: make default messages and dynamic content syntax

Author: MantisClone

.github/workflows/pr-auto-comments.yml

@@ -16,17 +16,17 @@ on:
         description: 'Message for first PR comments (leave empty to disable first PR comments)'
         required: false
         type: string
-        default: ''
+        default: 'Hello @{{username}}, thank you for submitting your first pull request to the {{repository}} repository. We value your contribution and encourage you to review our contribution guidelines to ensure your submission meets our standards. Please note that every merged PR is automatically enrolled in our Best PR Initiative, offering a chance to win $500 each quarter. Our team is available via GitHub Discussions or Discord if you have any questions. Welcome aboard!'
       ready_for_review_comment:
         description: 'Message for PR ready for review comments (leave empty to disable ready for review comments)'
         required: false
         type: string
-        default: ''
+        default: 'Thank you for your submission! As you prepare for the review process, please ensure that your PR title, description, and any linked issues fully comply with our contribution guidelines. A clear explanation of your changes and their context will help expedite the review process. Every merged PR is automatically entered into our Best PR Initiative, offering a chance to win $500 every quarter. We appreciate your attention to detail and look forward to reviewing your contribution!'
       merged_pr_comment:
         description: 'Message for merged PR comments (leave empty to disable merged PR comments)'
         required: false
         type: string
-        default: ''
+        default: 'Congratulations, your pull request has been merged! Thank you for your valuable contribution to Request Network. As a reminder, every merged PR is automatically entered into our Best PR Initiative, offering a quarterly prize of $500. Your work significantly supports our project\'s growth, and we encourage you to continue engaging with our community. Additionally, if you want to build or add crypto payments and invoicing features, explore how our API can reduce deployment time from months to hours while offering advanced features. Book a call with our expert to learn more and fast-track your development.'
     secrets:
       token:
         description: 'GitHub token with org:read permission'
@@ -127,11 +127,23 @@ jobs:
         with:
           github-token: ${{ github.token }}
           script: |
+            const variables = {
+              username: context.payload.pull_request.user.login,
+              repository: context.payload.repository.name,
+              org: context.repo.owner,
+            };
+
+            let commentBody = `${{ inputs.first_pr_comment }}`;
+            Object.entries(variables).forEach(([key, value]) => {
+              const regex = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+              commentBody = commentBody.replace(regex, value);
+            });
+
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: `${{ inputs.first_pr_comment }}`
+              body: commentBody
             });
 
   # Leave a comment when PR is marked ready for review
@@ -146,11 +158,23 @@ jobs:
         with:
           github-token: ${{ github.token }}
           script: |
+            const variables = {
+              username: context.payload.pull_request.user.login,
+              repository: context.payload.repository.name,
+              org: context.repo.owner,
+            };
+
+            let commentBody = `${{ inputs.ready_for_review_comment }}`;
+            Object.entries(variables).forEach(([key, value]) => {
+              const regex = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+              commentBody = commentBody.replace(regex, value);
+            });
+
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: `${{ inputs.ready_for_review_comment }}`
+              body: commentBody
             });
 
   # Leave a comment when PR is merged
@@ -165,9 +189,21 @@ jobs:
         with:
           github-token: ${{ github.token }}
           script: |
+            const variables = {
+              username: context.payload.pull_request.user.login,
+              repository: context.payload.repository.name,
+              org: context.repo.owner,
+            };
+
+            let commentBody = `${{ inputs.merged_pr_comment }}`;
+            Object.entries(variables).forEach(([key, value]) => {
+              const regex = new RegExp(`\\{\\{${key}\\}\\}`, 'g');
+              commentBody = commentBody.replace(regex, value);
+            });
+
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: `${{ inputs.merged_pr_comment }}`
+              body: commentBody
             });

README.md

@@ -28,16 +28,11 @@ jobs:
     uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@main
     with:
       org_name: "your-organization-name"
-      # Enable only the comment types you want by providing content
+      # Optional: override the default comments
       first_pr_comment: |
         # Welcome to our project!
 
-        Thanks for your first contribution. We're glad you're here.
-      # To disable a comment type, either remove it or leave it empty
-      merged_pr_comment: |
-        # PR Merged
-
-        Thank you for your contribution!
+        Thanks for your first contribution, @{{username}}. We're glad you're here.
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -52,36 +47,63 @@ jobs:
 
 ### Optional Inputs
 
-| Input | Description | Default | Behavior if not provided |
+| Input | Description | Default | Behavior if empty string |
 |-------|-------------|---------|--------------------------|
 | `additional_internal_users` | Additional comma-separated list of usernames to consider as internal | `''` | No additional users excluded |
-| `first_pr_comment` | Message for first PR comments | `''` | First PR comments disabled |
-| `ready_for_review_comment` | Message for ready for review comments | `''` | Ready for review comments disabled |
-| `merged_pr_comment` | Message for merged PR comments | `''` | Merged PR comments disabled |
+| `first_pr_comment` | Message for first PR comments | Default welcome message | First PR comments disabled |
+| `ready_for_review_comment` | Message for ready for review comments | Default guidelines message | Ready for review comments disabled |
+| `merged_pr_comment` | Message for merged PR comments | Default thank you message | Merged PR comments disabled |
 
 ### Secrets
 
 | Secret | Description | Required | Default |
 |--------|-------------|----------|---------|
 | `token` | GitHub token with org:read permission | No | `github.token` |
 
+## Default Messages
+
+The workflow includes default messages for each comment type:
+
+### First PR Comment
+A welcome message that mentions the contributor by username, introduces them to the project, and highlights the Best PR Initiative with its $500 quarterly prize.
+
+### Ready for Review Comment
+A reminder about contribution guidelines and the Best PR Initiative, encouraging clear PR descriptions to expedite the review process.
+
+### Merged PR Comment
+A congratulatory message that thanks the contributor, reminds them about the Best PR Initiative, and promotes the Request Network API for crypto payments and invoicing features.
+
 ## Enabling and Disabling Comment Types
 
-You can selectively enable comment types by providing content for the corresponding input:
+By default, all comment types are enabled with predefined messages. You can:
+
+- **Override** a default comment by providing your own message text
+- **Disable** a comment type by providing an empty string `''`
+
+For example, to disable ready for review comments:
 
-- To **enable** a comment type: provide the message text
-- To **disable** a comment type: omit the input or provide an empty string
+```yaml
+ready_for_review_comment: ''  # Explicitly set to empty string to disable
+```
+
+## Dynamic Content with Variable Placeholders
+
+You can include dynamic content in your messages using placeholders with the format `{{variable}}`. The following variables are available:
 
-For example, to enable only first PR and merged PR comments:
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `{{username}}` | The PR author's username | `octocat` |
+| `{{repository}}` | The repository name | `auto-comments` |
+| `{{org}}` | The organization/owner name | `your-org` |
+
+Example usage in a custom message:
 
 ```yaml
 first_pr_comment: |
-  # Welcome!
-  Thanks for your contribution.
-# ready_for_review_comment is omitted to disable it
-merged_pr_comment: |
-  # Merged
-  Your PR has been merged.
+  # Welcome @{{username}}!
+
+  Thank you for your first contribution to the {{repository}} repository.
+  We at {{org}} appreciate your interest in our project.
 ```
 
 ## Comment Formatting
@@ -95,6 +117,10 @@ You can use full Markdown syntax in your comment messages, including:
 - Code blocks
 - Emojis (`:tada:`)
 
+## Special Placeholders
+
+The first PR comment supports the `@<username>` placeholder, which will be automatically replaced with the PR author's username.
+
 ## How It Works
 
 1. The workflow first checks the PR author in a central job:
@@ -103,7 +129,7 @@ You can use full Markdown syntax in your comment messages, including:
 
 2. Based on the event type (opened/ready for review/merged) and author status:
    - Runs only the appropriate comment job
-   - Only if the corresponding comment text is provided
+   - Only if the corresponding comment text is not empty
 
 3. Each enabled job posts its specific comment to the PR
 

example-usage.yml

@@ -5,59 +5,37 @@ on:
     types: [opened, ready_for_review, closed]
 
 jobs:
-  # Example 1: All comment types enabled
-  pr-comments-all:
+  # Example 1: Using default comments
+  pr-comments-defaults:
     uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@main
     with:
       org_name: "your-organization-name"
       additional_internal_users: "external-consultant,bot-account"
-
-      # First PR comment
-      first_pr_comment: |
-        # 🌟 Welcome to your first contribution!
-
-        We're thrilled to see your first PR to our project. Here at [Organization], we value every contribution.
-
-        ## Next steps
-        - Our team will review your changes soon
-        - You might get some feedback or requests for changes
-        - Feel free to ask questions if anything is unclear
-
-        Thank you for taking the time to contribute to our project!
-
-      # Ready for review comment
-      ready_for_review_comment: |
-        # Ready for review - thank you!
-
-        Your PR has been marked as ready for review and will be reviewed by our team soon.
-
-        Please allow 2-3 business days for the review process.
-
-      # Merged PR comment
-      merged_pr_comment: |
-        # Congratulations! 🎉
-
-        Your PR has been merged successfully. Thank you for your valuable contribution!
-
-        Your changes will be included in the next release of our software.
+      # No comment content provided - will use defaults
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
 
-  # Example 2: Only specific comment types enabled
-  pr-comments-selective:
+  # Example 2: Customizing some comments, disabling others
+  pr-comments-custom:
     uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@main
     with:
       org_name: "your-organization-name"
 
-      # Only enable first PR and merged PR comments
+      # Custom first PR comment with variable placeholders
       first_pr_comment: |
-        # Welcome to our project!
-        Thank you for your first contribution!
+        # Welcome @{{username}}!
+
+        Thank you for your first contribution to the {{repository}} repository.
+        Our {{org}} team will review your changes soon.
 
-      # Ready for review comments disabled by not providing this input
+      # Disable ready for review comments
+      ready_for_review_comment: ''
 
+      # Custom merged PR comment with variable placeholders
       merged_pr_comment: |
-        # PR Merged
-        Thank you for your contribution!
+        # Congratulations on your merged PR! 🎉
+
+        Thank you @{{username}} for your contribution to {{repository}}!
+        Your changes are now part of the {{org}} codebase.
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}