Skip to content

Commit ebb6f2b

Browse files
authored
Update README.md and docs
1 parent 5ce007a commit ebb6f2b

1 file changed

Lines changed: 70 additions & 135 deletions

File tree

README.md

Lines changed: 70 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11

22
<!-- markdownlint-disable -->
3-
# github-action-wait-commit-status [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-wait-commit-status.svg)](https://github.com/cloudposse/github-action-wait-commit-status/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-wait-commit-status <a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
4+
<a href="https://github.com/cloudposse/github-action-wait-commit-status/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-wait-commit-status.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
45
<!-- markdownlint-restore -->
56

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
107
<!--
118
129
1310
1411
1512
** DO NOT EDIT THIS FILE
1613
**
17-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
1815
** 1) Make all changes to `README.yaml`
1916
** 2) Run `make init` (you only need to do this once)
2017
** 3) Run`make readme` to rebuild this file.
@@ -30,30 +27,17 @@
3027

3128
Wait for commit status
3229

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-
54-
5530

31+
---
32+
> [!NOTE]
33+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
34+
> <details><summary>Learn More</summary>
35+
>
36+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
37+
>
38+
> </details>
5639
40+
[![README Header][readme_header_img]][readme_header_link]
5741

5842

5943
## Introduction
@@ -62,8 +46,6 @@ Checks GitHub API for a given commit and look the commit status.
6246

6347

6448

65-
66-
6749
## Usage
6850

6951

@@ -115,15 +97,6 @@ Checks GitHub API for a given commit and look the commit status.
11597
<!-- markdownlint-restore -->
11698
11799
118-
119-
## Share the Love
120-
121-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-wait-commit-status)! (it helps us **a lot**)
122-
123-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
124-
125-
126-
127100
## Related Projects
128101
129102
Check out these related projects.
@@ -138,87 +111,88 @@ For additional context, refer to some of these links.
138111
- [github-action-deploy-argocd](https://github.com/cloudposse/github-action-deploy-argocd) - Deploy on Kubernetes with ArgoCD
139112
140113
141-
## Help
142-
143-
**Got a question?** We got answers.
144-
145-
File a GitHub [issue](https://github.com/cloudposse/github-action-wait-commit-status/issues), send us an [email][email] or join our [Slack Community][slack].
114+
## ✨ Contributing
146115
147-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
116+
This project is under active development, and we encourage contributions from our community.
117+
Many thanks to our outstanding contributors:
148118
149-
## DevOps Accelerator for Startups
119+
<a href="https://github.com/cloudposse/github-action-wait-commit-status/graphs/contributors">
120+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-wait-commit-status&max=24" />
121+
</a>
150122
123+
### 🐛 Bug Reports & Feature Requests
151124
152-
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.
125+
Please use the [issue tracker](https://github.com/cloudposse/github-action-wait-commit-status/issues) to report any bugs or file feature requests.
153126
154-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
127+
### 💻 Developing
155128
156-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
129+
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!
130+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
157131

158-
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.
132+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
133+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-wait-commit-status/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
134+
2. **Fork** the repo on GitHub
135+
3. **Clone** the project to your own machine
136+
4. **Commit** changes to your own branch
137+
5. **Push** your work back up to your fork
138+
6. Submit a **Pull Request** so that we can review your changes
159139

160-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
161-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
162-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
163-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
164-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
165-
- **Training.** You'll receive hands-on training so your team can operate what we build.
166-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
167-
- **Troubleshooting.** You'll get help to triage when things aren't working.
168-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
169-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
140+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
170141

171-
## Slack Community
142+
### 🌎 Slack Community
172143

173144
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.
174145

175-
## Discourse Forums
176-
177-
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.
178-
179-
## Newsletter
180-
181-
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.
146+
### 📰 Newsletter
182147

183-
## Office Hours
148+
Sign up for [our newsletter][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.
149+
Dropped straight into your Inbox every week — and usually a 5-minute read.
184150

185-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
151+
### 📆 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" />
186152

187-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
153+
[Join us every Wednesday via Zoom][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.
154+
It's **FREE** for everyone!
188155

189-
## Contributing
190-
191-
### Bug Reports & Feature Requests
192-
193-
Please use the [issue tracker](https://github.com/cloudposse/github-action-wait-commit-status/issues) to report any bugs or file feature requests.
194-
195-
### Developing
196-
197-
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].
198-
199-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
156+
## About
200157

201-
1. **Fork** the repo on GitHub
202-
2. **Clone** the project to your own machine
203-
3. **Commit** changes to your own branch
204-
4. **Push** your work back up to your fork
205-
5. Submit a **Pull Request** so that we can review your changes
158+
This project is maintained by [Cloud Posse, LLC][website].
159+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
206160

207-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
161+
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
162+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
163+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
208164

165+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
209166

210-
## Copyright
167+
*Your team can operate like a pro today.*
211168

212-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
169+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
213170

171+
<details>
172+
<summary>📚 <strong>What's included?</strong></summary>
214173

174+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
175+
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
176+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
177+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
178+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
179+
- **Training.** You'll receive hands-on training so your team can operate what we build.
180+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
181+
- **Troubleshooting.** You'll get help to triage when things aren't working.
182+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
183+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
184+
</details>
215185

186+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
216187
## License
217188

218-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
219-
220-
See [LICENSE](LICENSE) for full details.
189+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
221190

191+
<details>
192+
<summary>Preamble to the Apache License, Version 2.0</summary>
193+
<br/>
194+
<br/>
195+
Complete license is available in the [`LICENSE`](LICENSE) file.
222196
```text
223197
Licensed to the Apache Software Foundation (ASF) under one
224198
or more contributor license agreements. See the NOTICE file
@@ -237,43 +211,13 @@ KIND, either express or implied. See the License for the
237211
specific language governing permissions and limitations
238212
under the License.
239213
```
240-
241-
242-
243-
244-
245-
246-
247-
214+
</details>
248215

249216
## Trademarks
250217

251218
All other trademarks referenced herein are the property of their respective owners.
252-
253-
## About
254-
255-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
256-
257-
[![Cloud Posse][logo]][website]
258-
259-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
260-
261-
We offer [paid support][commercial_support] on all of our projects.
262-
263-
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.
264-
265-
266-
267-
### Contributors
268-
269-
<!-- markdownlint-disable -->
270-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
271-
|---|
272-
<!-- markdownlint-restore -->
273-
274-
[goruha_homepage]: https://github.com/goruha
275-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
276-
219+
---
220+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
277221
[![README Footer][readme_footer_img]][readme_footer_link]
278222
[![Beacon][beacon]][website]
279223
<!-- markdownlint-disable -->
@@ -284,12 +228,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
284228
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=jobs
285229
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=hire
286230
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=slack
287-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=linkedin
288231
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=twitter
289-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=testimonial
290232
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=office_hours
291233
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=newsletter
292-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=discourse
293234
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=email
294235
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=commercial_support
295236
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=we_love_open_source
@@ -300,11 +241,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
300241
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=readme_footer_link
301242
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
302243
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=readme_commercial_support_link
303-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-wait-commit-status&url=https://github.com/cloudposse/github-action-wait-commit-status
304-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-wait-commit-status&url=https://github.com/cloudposse/github-action-wait-commit-status
305-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-wait-commit-status
306-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-wait-commit-status
307-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-wait-commit-status
308-
[share_email]: mailto:?subject=github-action-wait-commit-status&body=https://github.com/cloudposse/github-action-wait-commit-status
309244
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-wait-commit-status?pixel&cs=github&cm=readme&an=github-action-wait-commit-status
310245
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)