Skip to content

Commit 10ac0be

Browse files
committed
chore: update README.md
1 parent 7b68874 commit 10ac0be

File tree

1 file changed

+37
-57
lines changed

1 file changed

+37
-57
lines changed

README.md

Lines changed: 37 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1+
2+
13
<!-- markdownlint-disable -->
2-
<a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/>
3-
<p align="right">
4-
<a href="https://github.com/cloudposse/example-github-action-composite/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/example-github-action-composite.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-github-actions/pr-comment-on-release/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/example-github-action-composite/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/example-github-action-composite.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
8+
9+
</p>
510
<!-- markdownlint-restore -->
611

712
<!--
@@ -13,8 +18,8 @@
1318
**
1419
** This file was automatically generated by the `cloudposse/build-harness`.
1520
** 1) Make all changes to `README.yaml`
16-
** 2) Run `make init` (you only need to do this once)
17-
** 3) Run`make readme` to rebuild this file.
21+
** 2) Install [atmos](https://atmos.tools/install/) (you only need to do this once)
22+
** 3) Run`atmos readme` to rebuild this file.
1823
**
1924
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
2025
**
@@ -28,17 +33,6 @@
2833
Comments on a PR when it is included in a GitHub release.
2934

3035

31-
---
32-
> [!NOTE]
33-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=) approach towards DevOps.
34-
> <details><summary><strong>Learn More</strong></summary>
35-
>
36-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
37-
>
38-
> We have [*dozens of GitHub Actions*](https://github.com/cloudposse-github-actions?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=github_actions) that are Open Source and well-maintained. Check them out!
39-
> </details>
40-
41-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
4236

4337

4438
## Introduction
@@ -91,6 +85,24 @@ This action returns a JSON-encoded string, which contains information on the com
9185

9286

9387

88+
## Inputs
89+
<!-- markdownlint-disable -->
90+
| Name | Description | Default | Required |
91+
|------|-------------|---------|----------|
92+
| 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 |
93+
| retries | Number of retries. | 0 | false |
94+
| tag | The git tag used to determine the release. If omitted, the release will be determined from `github.event.release.id`. | N/A | false |
95+
<!-- markdownlint-restore -->
96+
97+
98+
## Outputs
99+
<!-- markdownlint-disable -->
100+
| Name | Description |
101+
|------|-------------|
102+
| result | A JSON-encoded string which contains information on the comments it created (if any). |
103+
<!-- markdownlint-restore -->
104+
105+
94106

95107
## Related Projects
96108

@@ -105,23 +117,21 @@ For additional context, refer to some of these links.
105117
- [cloudposse-github-actions](https://github.com/cloudposse-github-actions) - Reusable workflows for different types of projects
106118

107119

120+
121+
108122
## ✨ Contributing
109123

110124
This project is under active development, and we encourage contributions from our community.
125+
126+
127+
111128
Many thanks to our outstanding contributors:
112129

113130
<a href="https://github.com/cloudposse-github-actions/pr-comment-on-release/graphs/contributors">
114131
<img src="https://contrib.rocks/image?repo=cloudposse-github-actions/pr-comment-on-release&max=24" />
115132
</a>
116133

117-
### 🐛 Bug Reports & Feature Requests
118-
119-
Please use the [issue tracker](https://github.com/cloudposse-github-actions/pr-comment-on-release/issues) to report any bugs or file feature requests.
120-
121-
### 💻 Developing
122-
123-
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!
124-
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.
134+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse-github-actions/pr-comment-on-release/issues).
125135

126136
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
127137
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).
@@ -144,40 +154,8 @@ Dropped straight into your Inbox every week — and usually a 5-minute read.
144154

145155
### 📆 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>
146156

147-
[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.
157+
[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 Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
148158
It's **FREE** for everyone!
149-
150-
## About
151-
152-
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>.
153-
<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>
154-
155-
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.
156-
Use our ready-to-go terraform architecture blueprints for AWS & GitHub Actions to get up and running quickly.
157-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
158-
159-
<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>
160-
161-
*Your team can operate like a pro today.*
162-
163-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
164-
165-
<details>
166-
<summary>📚 <strong>See What's Included</strong></summary>
167-
168-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
169-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
170-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
171-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
172-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
173-
- **Training.** You'll receive hands-on training so your team can operate what we build.
174-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
175-
- **Troubleshooting.** You'll get help to triage when things aren't working.
176-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
177-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
178-
</details>
179-
180-
<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>
181159
## License
182160

183161
<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>
@@ -212,6 +190,8 @@ under the License.
212190
## Trademarks
213191

214192
All other trademarks referenced herein are the property of their respective owners.
193+
194+
215195
---
216196
Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
217197

0 commit comments

Comments
 (0)