simplify positive test case; update readme and run 'make readme'.

korenyoni · korenyoni · commit 8cb8a435859a · 2025-03-24T15:23:56.000-04:00
diff --git a/.github/workflows/test-negative.yml b/.github/workflows/test-negative.yml
@@ -59,6 +59,7 @@ jobs:
         uses: peter-evans/find-comment@v3
         id: fc
         with:
+          continue-on-error: true
           issue-number: ${{ fromJSON(steps.action.outputs.result).comments[0].pull_request }}
           body-includes: ${{ needs.create-release.outputs.tag }}
 
diff --git a/.github/workflows/test-positive.yml b/.github/workflows/test-positive.yml
@@ -62,16 +62,6 @@ jobs:
           issue-number: ${{ fromJSON(steps.action.outputs.result).comments[0].pull_request }}
           body-includes: ${{ needs.create-release.outputs.tag }}
 
-      - name: Succeed if comment was found
-        if: ${{ always() && steps.fc.outputs.comment-id != 0 }}
-        run: |
-          exit 0
-
-      - name: Fail if comment was not found
-        if: ${{ always() && steps.fc.outputs.comment-id == 0 }}
-        run: |
-          exit 1
-
   teardown:
     runs-on: ubuntu-latest
     needs: [create-release, assert]
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@
 
 -->
 
-Comments on a (merged) PR when it is included in a GitHub release.
+Comments on a PR when it is included in a GitHub release.
 
 
 ---
@@ -42,21 +42,9 @@ Comments on a (merged) PR when it is included in a GitHub release.
 
 ## Introduction
 
-This composite action comments on a (merged) Pull Request when it is included in a GitHub release.
-
-
-
-## Usage
-
-
-
-> [!IMPORTANT]
-> In Cloud Posse's examples, we avoid pinning GitHub Actions to specific versions to prevent discrepancies between the documentation 
-> and the latest released versions. However, for your own projects, we strongly advise pinning each GitHub Action to the exact version
-> you're using. This practice ensures the stability of your workflows. Additionally, we recommend implementing a systematic 
-> approach for updating versions to avoid unexpected changes.
-
+This action comments on a PR when it has commits associated with a release.
 
+This action should typically be called in a worklow with the `on.release` trigger:
 
 ```yaml
   name: PR Comment on Release
@@ -79,11 +67,155 @@ This composite action comments on a (merged) Pull Request when it is included in
           uses: cloudposse-github-actions/pr-comment-on-release
           id: pr-comment-on-release
           with:
-            retries: 5 # Override number of retries
+            # Optional: only comment on PRs when the release matches a certain regex (default: ".*")
+            include_regex: "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"
 ```
 
+This action returns a JSON-encoded string, which contains information on the comments it created (if any):
+
+```jsonc
+{
+  "comments": [
+    "pull_request": 1, // the PR #
+    "comment_id": 12345 // the comment ID
+  ]
+}
+```
+
+
+
+
+
+
+
+
+
+
+## Related Projects
+
+Check out these related projects.
+
+
+
+## References
+
+For additional context, refer to some of these links.
+
+- [cloudposse-github-actions](https://github.com/cloudposse-github-actions) - Reusable workflows for different types of projects
+- [pr-comment-on-release](https://github.com/cloudposse-github-actions/pr-comment-on-release) - Example application with complicated release workflow
+
+
+## ✨ Contributing
+
+This project is under active development, and we encourage contributions from our community.
+Many thanks to our outstanding contributors:
+
+<a href="https://github.com/cloudposse-github-actions/pr-comment-on-release/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=cloudposse-github-actions/pr-comment-on-release&max=24" />
+</a>
 
+### 🐛 Bug Reports & Feature Requests
 
+Please use the [issue tracker](https://github.com/cloudposse-github-actions/pr-comment-on-release/issues) to report any bugs or file feature requests.
+
+### 💻 Developing
+
+If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! 
+Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=slack), in the `#cloudposse` channel.
+
+In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
+ 1. Review our [Code of Conduct](https://github.com/cloudposse-github-actions/pr-comment-on-release/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
+ 2. **Fork** the repo on GitHub
+ 3. **Clone** the project to your own machine
+ 4. **Commit** changes to your own branch
+ 5. **Push** your work back up to your fork
+ 6. Submit a **Pull Request** so that we can review your changes
+
+**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
+
+### 🌎 Slack Community
+
+Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
+
+### 📰 Newsletter
+
+Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
+Dropped straight into your Inbox every week — and usually a 5-minute read.
+
+### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
+
+[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and GitHub Action insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
+It's **FREE** for everyone!
+
+## About
+
+This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=">Cloud Posse, LLC</a>.
+<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
+
+We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=commercial_support) for funded startups and enterprises.
+Use our ready-to-go terraform architecture blueprints for AWS & GitHub Actions to get up and running quickly.
+We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
+
+<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
+
+*Your team can operate like a pro today.*
+
+Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
+
+<details>
+  <summary>📚 <strong>See What's Included</strong></summary>
+
+- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
+- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
+- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
+- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
+- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
+- **Training.** You'll receive hands-on training so your team can operate what we build.
+- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
+- **Troubleshooting.** You'll get help to triage when things aren't working.
+- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
+- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
+</details>
+
+<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
+## License
+
+<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
+
+<details>
+<summary>Preamble to the Apache License, Version 2.0</summary>
+<br/>
+<br/>
+
+Complete license is available in the [`LICENSE`](LICENSE) file.
+
+```text
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+```
+</details>
+
+## Trademarks
+
+All other trademarks referenced herein are the property of their respective owners.
+---
+Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
 
 
+<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
 
+<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-github-actions/pr-comment-on-release?pixel&cs=github&cm=readme&an=pr-comment-on-release"/>
diff --git a/README.yaml b/README.yaml
@@ -32,21 +32,13 @@ badges:
 related: []
 
 # Short description of this project
-description: Comments on a (merged) PR when it is included in a GitHub release.
+description: Comments on a PR when it is included in a GitHub release.
 
 introduction: |-
-  This composite action comments on a (merged) Pull Request when it is included in a GitHub release.
+  This action comments on a PR when it has commits associated with a release.
 
-references:
-  - name: "cloudposse-github-actions"
-    description: "Reusable workflows for different types of projects"
-    url: "https://github.com/cloudposse-github-actions"
-  - name: "pr-comment-on-release"
-    description: "Example application with complicated release workflow"
-    url: "https://github.com/cloudposse-github-actions/pr-comment-on-release"
+  This action should typically be called in a worklow with the `on.release` trigger:
 
-# How to use this project
-usage: |-
   ```yaml
     name: PR Comment on Release
     
@@ -68,10 +60,30 @@ usage: |-
             uses: cloudposse-github-actions/pr-comment-on-release
             id: pr-comment-on-release
             with:
-              retries: 5 # Override number of retries
+              # Optional: only comment on PRs when the release matches a certain regex (default: ".*")
+              include_regex: "^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"
+  ```
+
+  This action returns a JSON-encoded string, which contains information on the comments it created (if any):
+
+  ```jsonc
+  {
+    "comments": [
+      "pull_request": 1, // the PR #
+      "comment_id": 12345 // the comment ID
+    ]
+  }
   ```
 
-include:
+references:
+  - name: "cloudposse-github-actions"
+    description: "Reusable workflows for different types of projects"
+    url: "https://github.com/cloudposse-github-actions"
+  - name: "pr-comment-on-release"
+    description: "Example application with complicated release workflow"
+    url: "https://github.com/cloudposse-github-actions/pr-comment-on-release"
+
+includes:
   - "docs/github-action.md"
 
 # Contributors to this project
diff --git a/action.yml b/action.yml
@@ -1,30 +1,24 @@
 name: "PR Comment on Release"
-description: |
-  Comments on a PR when it is included in a GitHub release.
-
-  This action should typically be called in a worklow with the `on.release` trigger.
+description: "Comments on a PR when it is included in a GitHub release."
 author: hello@cloudposse.com
 branding:
-  icon: "file"
+  icon: "git-pull-request"
   color: "white"
 inputs:
   retries:
     required: false
-    description: "Number of retries"
-    default: "3"
+    description: "Number of retries."
+    default: "0"
   include_regex:
     required: false
-    description: |
-      Only include releases whose tag name matches this regular expression.
-      This regular expression should not include delimeters. i.e. instead of `/.*/g`, supply only `.*`.
+    description: "Only include releases whose tag name matches this regular expression. This regular expression should not include delimeters. i.e. instead of `/.*/g`, supply only `.*`."
     default: ".*"
   tag:
     required: false
     description: "The git tag used to determine the release. If omitted, the release will be determined from `github.event.release.id`."
-    default: ""
 outputs:
   result:
-    description: "A JSON-encoded list of objects detailing the ID of each PR and the comment created by this action."
+    description: "A JSON-encoded string, which contains information on the comments it created (if any)."
     value: ${{ steps.pr-comment-on-release.outputs.result }}
 runs:
   using: "composite"
diff --git a/docs/github-action.md b/docs/github-action.md
@@ -4,7 +4,14 @@
 
 | Name | Description | Default | Required |
 |------|-------------|---------|----------|
-| retries | Number of retries | 3 | false |
+| include\_regex | Only include releases whose tag name matches this regular expression. This regular expression should not include delimeters. i.e. instead of `/.\*/g`, supply only `.\*`. | .\* | false |
+| retries | Number of retries. | 0 | false |
+| tag | The git tag used to determine the release. If omitted, the release will be determined from `github.event.release.id`. | N/A | false |
 
 
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| result | A JSON-encoded string, which contains information on the comments it created (if any). |
 <!-- markdownlint-restore -->
