Skip to content

Commit cad323e

Browse files
korenyonikorenyoni
committed
Rebuild docs.
1 parent 92085c3 commit cad323e

File tree

2 files changed

+37
-260
lines changed

2 files changed

+37
-260
lines changed

‎README.md‎

Lines changed: 36 additions & 254 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
21
<!-- markdownlint-disable -->
3-
# example-github-action-composite [![Latest Release](https://img.shields.io/github/release/cloudposse/example-github-action-composite.svg)](https://github.com/cloudposse/example-github-action-composite/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
2+
# pr-comment-on-release <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/pr-comment-on-release&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3+
<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>
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
106
<!--
117
128
139
1410
1511
** DO NOT EDIT THIS FILE
1612
**
17-
** This file was automatically generated by the `build-harness`.
13+
** This file was automatically generated by the `cloudposse/build-harness`.
1814
** 1) Make all changes to `README.yaml`
1915
** 2) Run `make init` (you only need to do this once)
2016
** 3) Run`make readme` to rebuild this file.
@@ -28,280 +24,66 @@
2824
2925
-->
3026

31-
Template repository of composite GitHub Action
32-
33-
---
34-
35-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
36-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
37-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
38-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
39-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
40-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
41-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
42-
43-
44-
45-
46-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
47-
48-
49-
50-
51-
52-
53-
27+
Comments on a (merged) PR when it is included in a GitHub release.
5428

5529

30+
---
31+
> [!NOTE]
32+
> 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.
33+
> <details><summary><strong>Learn More</strong></summary>
34+
>
35+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
36+
>
37+
> 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!
38+
> </details>
5639
40+
<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>
5741

5842

5943
## Introduction
6044

61-
This is template repository to create composite GitHub Actions.
62-
Feel free to use it as reference and starting point.
45+
This composite action comments on a (merged) Pull Request when it is included in a GitHub release.
6346

6447

6548

49+
## Usage
6650

6751

68-
## Usage
52+
53+
> [!IMPORTANT]
54+
> In Cloud Posse's examples, we avoid pinning GitHub Actions to specific versions to prevent discrepancies between the documentation
55+
> and the latest released versions. However, for your own projects, we strongly advise pinning each GitHub Action to the exact version
56+
> you're using. This practice ensures the stability of your workflows. Additionally, we recommend implementing a systematic
57+
> approach for updating versions to avoid unexpected changes.
6958
7059

7160

7261
```yaml
73-
name: Pull Request
62+
name: PR Comment on Release
63+
7464
on:
75-
pull_request:
76-
branches: [ 'main' ]
77-
types: [opened, synchronize, reopened, closed, labeled, unlabeled]
65+
release:
66+
types: [published]
67+
68+
permissions:
69+
deployments: write
70+
id-token: write
71+
contents: write
72+
pull-requests: write
7873

7974
jobs:
8075
context:
8176
runs-on: ubuntu-latest
8277
steps:
83-
- name: Example action
84-
uses: cloudposse/example-github-action-composite@main
85-
id: example
78+
- name: Comment on Release
79+
uses: cloudposse-github-actions/pr-comment-on-release
80+
id: pr-comment-on-release
8681
with:
87-
param1: true
88-
89-
outputs:
90-
result: ${{ steps.example.outputs.result1 }}
91-
```
92-
93-
94-
95-
96-
97-
98-
<!-- markdownlint-disable -->
99-
100-
## Inputs
101-
102-
| Name | Description | Default | Required |
103-
|------|-------------|---------|----------|
104-
| param1 | Input parameter placeholder | true | true |
105-
106-
107-
## Outputs
108-
109-
| Name | Description |
110-
|------|-------------|
111-
| result1 | Output result placeholder |
112-
<!-- markdownlint-restore -->
113-
114-
115-
116-
## Share the Love
117-
118-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/example-github-action-composite)! (it helps us **a lot**)
119-
120-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
121-
122-
123-
124-
## Related Projects
125-
126-
Check out these related projects.
127-
128-
129-
130-
## References
131-
132-
For additional context, refer to some of these links.
133-
134-
- [github-actions-workflows](https://github.com/cloudposse/github-actions-workflows) - Reusable workflows for different types of projects
135-
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
136-
137-
138-
## Help
139-
140-
**Got a question?** We got answers.
141-
142-
File a GitHub [issue](https://github.com/cloudposse/example-github-action-composite/issues), send us an [email][email] or join our [Slack Community][slack].
143-
144-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
145-
146-
## DevOps Accelerator for Startups
147-
148-
149-
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
150-
151-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
152-
153-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
154-
155-
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
156-
157-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
158-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
159-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
160-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
161-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
162-
- **Training.** You'll receive hands-on training so your team can operate what we build.
163-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
164-
- **Troubleshooting.** You'll get help to triage when things aren't working.
165-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
166-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
167-
168-
## Slack Community
169-
170-
Join our [Open Source Community][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.
171-
172-
## Discourse Forums
173-
174-
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
175-
176-
## Newsletter
177-
178-
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
179-
180-
## Office Hours
181-
182-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
183-
184-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
185-
186-
## Contributing
187-
188-
### Bug Reports & Feature Requests
189-
190-
Please use the [issue tracker](https://github.com/cloudposse/example-github-action-composite/issues) to report any bugs or file feature requests.
191-
192-
### Developing
193-
194-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
195-
196-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
197-
198-
1. **Fork** the repo on GitHub
199-
2. **Clone** the project to your own machine
200-
3. **Commit** changes to your own branch
201-
4. **Push** your work back up to your fork
202-
5. Submit a **Pull Request** so that we can review your changes
203-
204-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
205-
206-
207-
## Copyright
208-
209-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
210-
211-
212-
213-
## License
214-
215-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
216-
217-
See [LICENSE](LICENSE) for full details.
218-
219-
```text
220-
Licensed to the Apache Software Foundation (ASF) under one
221-
or more contributor license agreements. See the NOTICE file
222-
distributed with this work for additional information
223-
regarding copyright ownership. The ASF licenses this file
224-
to you under the Apache License, Version 2.0 (the
225-
"License"); you may not use this file except in compliance
226-
with the License. You may obtain a copy of the License at
227-
228-
https://www.apache.org/licenses/LICENSE-2.0
229-
230-
Unless required by applicable law or agreed to in writing,
231-
software distributed under the License is distributed on an
232-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
233-
KIND, either express or implied. See the License for the
234-
specific language governing permissions and limitations
235-
under the License.
82+
retries: 5 # Override number of retries
23683
```
23784
23885
23986
24087
24188
24289
243-
244-
245-
246-
## Trademarks
247-
248-
All other trademarks referenced herein are the property of their respective owners.
249-
250-
## About
251-
252-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
253-
254-
[![Cloud Posse][logo]][website]
255-
256-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
257-
258-
We offer [paid support][commercial_support] on all of our projects.
259-
260-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
261-
262-
263-
264-
### Contributors
265-
266-
<!-- markdownlint-disable -->
267-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
268-
|---|
269-
<!-- markdownlint-restore -->
270-
271-
[goruha_homepage]: https://github.com/goruha
272-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
273-
274-
[![README Footer][readme_footer_img]][readme_footer_link]
275-
[![Beacon][beacon]][website]
276-
<!-- markdownlint-disable -->
277-
[logo]: https://cloudposse.com/logo-300x69.svg
278-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=docs
279-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=website
280-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=github
281-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=jobs
282-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=hire
283-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=slack
284-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=linkedin
285-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=twitter
286-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=testimonial
287-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=office_hours
288-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=newsletter
289-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=discourse
290-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=email
291-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=commercial_support
292-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=we_love_open_source
293-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=terraform_modules
294-
[readme_header_img]: https://cloudposse.com/readme/header/img
295-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=readme_header_link
296-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
297-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=readme_footer_link
298-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
299-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/example-github-action-composite&utm_content=readme_commercial_support_link
300-
[share_twitter]: https://twitter.com/intent/tweet/?text=example-github-action-composite&url=https://github.com/cloudposse/example-github-action-composite
301-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=example-github-action-composite&url=https://github.com/cloudposse/example-github-action-composite
302-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/example-github-action-composite
303-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/example-github-action-composite
304-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/example-github-action-composite
305-
[share_email]: mailto:?subject=example-github-action-composite&body=https://github.com/cloudposse/example-github-action-composite
306-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/example-github-action-composite?pixel&cs=github&cm=readme&an=example-github-action-composite
307-
<!-- markdownlint-restore -->

‎docs/github-action.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,7 @@
44

55
| Name | Description | Default | Required |
66
|------|-------------|---------|----------|
7-
| param1 | Input parameter placeholder | true | true |
7+
| retries | Number of retries | 3 | false |
88

99

10-
## Outputs
11-
12-
| Name | Description |
13-
|------|-------------|
14-
| result1 | Output result placeholder |
1510
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)