Skip to content

Commit b3babf4

Browse files
committed
chore: update README.md
1 parent 83a4f2c commit b3babf4

File tree

2 files changed

+38
-164
lines changed

2 files changed

+38
-164
lines changed

.github/banner.png

1000 KB
Loading

README.md

Lines changed: 38 additions & 164 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11

2-
<!-- markdownlint-disable -->
3-
# github-action-preview-environment-controller
42

5-
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-preview-environment-controller.svg)](https://github.com/cloudposse/github-action-preview-environment-controller/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
<!-- markdownlint-disable -->
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/github-action-preview-environment-controller/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5+
<p align="right">
6+
<a href="https://github.com/cloudposse/github-action-preview-environment-controller/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-preview-environment-controller.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>
67
<!-- markdownlint-restore -->
78

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
11-
129
<!--
1310
1411
1512
1613
1714
** DO NOT EDIT THIS FILE
1815
**
19-
** This file was automatically generated by the `build-harness`.
16+
** This file was automatically generated by the `cloudposse/build-harness`.
2017
** 1) Make all changes to `README.yaml`
2118
** 2) Run `make init` (you only need to do this once)
2219
** 3) Run`make readme` to rebuild this file.
@@ -32,29 +29,6 @@
3229

3330
Action to manage to deploy and purge preview environments depends on PR labels
3431

35-
---
36-
37-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
38-
[<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]
39-
[<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]
40-
[<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]
41-
[<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]
42-
[<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]
43-
[<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]
44-
45-
46-
47-
48-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
49-
50-
51-
52-
53-
54-
55-
56-
57-
5832

5933

6034

@@ -70,11 +44,8 @@ So it performs a `controller` role and does not limit deployment methods or tool
7044

7145

7246

73-
7447
## Usage
7548

76-
77-
7849
Use `github-action-preview-environment-controller` in Pull Request triggered pipeline, and use it's outputs to determinate
7950
what environments should be deployed and what cleaned up.
8051

@@ -164,15 +135,6 @@ what environments should be deployed and what cleaned up.
164135
<!-- markdownlint-restore -->
165136
166137
167-
168-
## Share the Love
169-
170-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-preview-environment-controller)! (it helps us **a lot**)
171-
172-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
173-
174-
175-
176138
## Related Projects
177139
178140
Check out these related projects.
@@ -187,86 +149,55 @@ For additional context, refer to some of these links.
187149
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
188150
189151
190-
## Help
191-
192-
**Got a question?** We got answers.
193-
194-
File a GitHub [issue](https://github.com/cloudposse/github-action-preview-environment-controller/issues), send us an [email][email] or join our [Slack Community][slack].
195-
196-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
197-
198-
## DevOps Accelerator for Startups
199-
200152
201-
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.
202153
203-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
154+
## ✨ Contributing
204155
205-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
156+
This project is under active development, and we encourage contributions from our community.
206157
207-
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.
208158
209-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
210-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
211-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
212-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
213-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
214-
- **Training.** You'll receive hands-on training so your team can operate what we build.
215-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
216-
- **Troubleshooting.** You'll get help to triage when things aren't working.
217-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
218-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
219159
220-
## Slack Community
160+
Many thanks to our outstanding contributors:
221161
222-
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.
162+
<a href="https://github.com/cloudposse/github-action-preview-environment-controller/graphs/contributors">
163+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-preview-environment-controller&max=24" />
164+
</a>
223165
224-
## Discourse Forums
225-
226-
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.
227-
228-
## Newsletter
229-
230-
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.
231-
232-
## Office Hours
233-
234-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
235-
236-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
237-
238-
## Contributing
239-
240-
### Bug Reports & Feature Requests
241-
242-
Please use the [issue tracker](https://github.com/cloudposse/github-action-preview-environment-controller/issues) to report any bugs or file feature requests.
243-
244-
### Developing
245-
246-
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].
166+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-preview-environment-controller/issues).
247167
248168
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
249-
250-
1. **Fork** the repo on GitHub
251-
2. **Clone** the project to your own machine
252-
3. **Commit** changes to your own branch
253-
4. **Push** your work back up to your fork
254-
5. Submit a **Pull Request** so that we can review your changes
169+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-preview-environment-controller/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
170+
2. **Fork** the repo on GitHub
171+
3. **Clone** the project to your own machine
172+
4. **Commit** changes to your own branch
173+
5. **Push** your work back up to your fork
174+
6. Submit a **Pull Request** so that we can review your changes
255175
256176
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
257177
178+
### 🌎 Slack Community
258179
259-
## Copyright
180+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&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.
260181
261-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
182+
### 📰 Newsletter
262183
184+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&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.
185+
Dropped straight into your Inbox every week — and usually a 5-minute read.
263186
187+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&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>
264188
189+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&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.
190+
It's **FREE** for everyone!
265191
## License
266192
267-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
193+
<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>
194+
195+
<details>
196+
<summary>Preamble to the Apache License, Version 2.0</summary>
197+
<br/>
198+
<br/>
268199
269-
See [LICENSE](LICENSE) for full details.
200+
Complete license is available in the [`LICENSE`](LICENSE) file.
270201

271202
```text
272203
Licensed to the Apache Software Foundation (ASF) under one
@@ -286,74 +217,17 @@ KIND, either express or implied. See the License for the
286217
specific language governing permissions and limitations
287218
under the License.
288219
```
289-
290-
291-
292-
293-
294-
295-
296-
220+
</details>
297221

298222
## Trademarks
299223

300224
All other trademarks referenced herein are the property of their respective owners.
301225

302-
## About
303-
304-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
305-
306-
[![Cloud Posse][logo]][website]
307-
308-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
309-
310-
We offer [paid support][commercial_support] on all of our projects.
311226

312-
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.
313-
314-
315-
316-
### Contributors
227+
---
228+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
317229

318-
<!-- markdownlint-disable -->
319-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
320-
|---|
321-
<!-- markdownlint-restore -->
322230

323-
[goruha_homepage]: https://github.com/goruha
324-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
231+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
325232

326-
[![README Footer][readme_footer_img]][readme_footer_link]
327-
[![Beacon][beacon]][website]
328-
<!-- markdownlint-disable -->
329-
[logo]: https://cloudposse.com/logo-300x69.svg
330-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=docs
331-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=website
332-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=github
333-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=jobs
334-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=hire
335-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=slack
336-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=linkedin
337-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=twitter
338-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=testimonial
339-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=office_hours
340-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=newsletter
341-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=discourse
342-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=email
343-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=commercial_support
344-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=we_love_open_source
345-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=terraform_modules
346-
[readme_header_img]: https://cloudposse.com/readme/header/img
347-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=readme_header_link
348-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
349-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=readme_footer_link
350-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
351-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-preview-environment-controller&utm_content=readme_commercial_support_link
352-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-preview-environment-controller&url=https://github.com/cloudposse/github-action-preview-environment-controller
353-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-preview-environment-controller&url=https://github.com/cloudposse/github-action-preview-environment-controller
354-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-preview-environment-controller
355-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-preview-environment-controller
356-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-preview-environment-controller
357-
[share_email]: mailto:?subject=github-action-preview-environment-controller&body=https://github.com/cloudposse/github-action-preview-environment-controller
358-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-preview-environment-controller?pixel&cs=github&cm=readme&an=github-action-preview-environment-controller
359-
<!-- markdownlint-restore -->
233+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-preview-environment-controller?pixel&cs=github&cm=readme&an=github-action-preview-environment-controller"/>

0 commit comments

Comments
 (0)