Skip to content

Commit 3032740

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

1 file changed

Lines changed: 48 additions & 128 deletions

File tree

README.md

Lines changed: 48 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
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> [![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)
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
96

107
<!--
118
@@ -30,30 +27,15 @@
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+
>
35+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
36+
>
5637
38+
[![README Header][readme_header_img]][readme_header_link]
5739

5840

5941
## Introduction
@@ -62,8 +44,6 @@ Checks GitHub API for a given commit and look the commit status.
6244

6345

6446

65-
66-
6747
## Usage
6848

6949

@@ -115,15 +95,6 @@ Checks GitHub API for a given commit and look the commit status.
11595
<!-- markdownlint-restore -->
11696
11797
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-
12798
## Related Projects
12899
129100
Check out these related projects.
@@ -138,81 +109,70 @@ For additional context, refer to some of these links.
138109
- [github-action-deploy-argocd](https://github.com/cloudposse/github-action-deploy-argocd) - Deploy on Kubernetes with ArgoCD
139110
140111
141-
## Help
112+
## ✨ Contributing
142113
143-
**Got a question?** We got answers.
114+
This project is under active development, and we encourage contributions from our community.
115+
Many thanks to our outstanding contributors:
144116
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].
117+
<a href="https://github.com/cloudposse/github-action-wait-commit-status/graphs/contributors">
118+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-wait-commit-status&max=24" />
119+
</a>
146120
147-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
148-
149-
## DevOps Accelerator for Startups
121+
### 🐛 Bug Reports & Feature Requests
150122
123+
Please use the [issue tracker](https://github.com/cloudposse/github-action-wait-commit-status/issues) to report any bugs or file 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+
### 💻 Developing
153126
154-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
127+
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 Cloud Posse's other projects, we would love to hear from you! Shoot us an [email][email].
155128
156-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
129+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
157130
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.
131+
1. **Fork** the repo on GitHub
132+
2. **Clone** the project to your own machine
133+
3. **Commit** changes to your own branch
134+
4. **Push** your work back up to your fork
135+
5. Submit a **Pull Request** so that we can review your changes
159136
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.
137+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
170138
171-
## Slack Community
139+
### 🌎 Slack Community
172140
173141
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.
174142
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
143+
### 📰 Newsletter
180144
181145
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.
182146
183-
## Office Hours
147+
### 📆 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" />
184148
185149
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
186150
187-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
188-
189-
## Contributing
151+
## About
190152
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.
200-
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
206-
207-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
153+
This project is maintained and funded by [Cloud Posse, LLC][website].
154+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
208155
156+
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.
209157
210-
## Copyright
158+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
211159
212-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
160+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
213161
162+
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.
214163
164+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
165+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
166+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
167+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
168+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
169+
- **Training.** You'll receive hands-on training so your team can operate what we build.
170+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
171+
- **Troubleshooting.** You'll get help to triage when things aren't working.
172+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
173+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
215174
175+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
216176
## License
217177
218178
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -238,42 +198,11 @@ specific language governing permissions and limitations
238198
under the License.
239199
```
240200

241-
242-
243-
244-
245-
246-
247-
248-
249201
## Trademarks
250202

251203
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-
204+
---
205+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
277206
[![README Footer][readme_footer_img]][readme_footer_link]
278207
[![Beacon][beacon]][website]
279208
<!-- markdownlint-disable -->
@@ -284,12 +213,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
284213
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=jobs
285214
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=hire
286215
[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
288216
[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
290217
[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
291218
[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
293219
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-wait-commit-status&utm_content=email
294220
[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
295221
[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 +226,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
300226
[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
301227
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
302228
[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
309229
[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
310230
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)