Skip to content

Commit 4d988d5

Browse files
authored
Update README.md and docs
1 parent 61f45ad commit 4d988d5

1 file changed

Lines changed: 70 additions & 137 deletions

File tree

README.md

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

22
<!-- markdownlint-disable -->
3-
# github-action-spacelift-stack-deploy
4-
5-
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-spacelift-stack-deploy.svg)](https://github.com/cloudposse/github-action-spacelift-stack-deploy/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-spacelift-stack-deploy <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-spacelift-stack-deploy/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-spacelift-stack-deploy.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
65
<!-- markdownlint-restore -->
76

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
11-
127
<!--
138
149
1510
1611
1712
** DO NOT EDIT THIS FILE
1813
**
19-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
2015
** 1) Make all changes to `README.yaml`
2116
** 2) Run `make init` (you only need to do this once)
2217
** 3) Run`make readme` to rebuild this file.
@@ -32,30 +27,17 @@
3227

3328
Trigger Spacelist stack synchronously
3429

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-
5730

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>
5839
40+
[![README Header][readme_header_img]][readme_header_link]
5941

6042

6143
## Introduction
@@ -66,8 +48,6 @@ The GitHub action triggers Spacelift stack run to provistion infrastructure.
6648

6749

6850

69-
70-
7151
## Usage
7252

7353

@@ -122,15 +102,6 @@ The GitHub action triggers Spacelift stack run to provistion infrastructure.
122102
<!-- markdownlint-restore -->
123103
124104
125-
126-
## Share the Love
127-
128-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-spacelift-stack-deploy)! (it helps us **a lot**)
129-
130-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
131-
132-
133-
134105
## Related Projects
135106
136107
Check out these related projects.
@@ -146,87 +117,88 @@ For additional context, refer to some of these links.
146117
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
147118
148119
149-
## Help
150-
151-
**Got a question?** We got answers.
120+
## ✨ Contributing
152121
153-
File a GitHub [issue](https://github.com/cloudposse/github-action-spacelift-stack-deploy/issues), send us an [email][email] or join our [Slack Community][slack].
122+
This project is under active development, and we encourage contributions from our community.
123+
Many thanks to our outstanding contributors:
154124
155-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
156-
157-
## DevOps Accelerator for Startups
125+
<a href="https://github.com/cloudposse/github-action-spacelift-stack-deploy/graphs/contributors">
126+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-spacelift-stack-deploy&max=24" />
127+
</a>
158128
129+
### 🐛 Bug Reports & Feature Requests
159130
160-
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.
131+
Please use the [issue tracker](https://github.com/cloudposse/github-action-spacelift-stack-deploy/issues) to report any bugs or file feature requests.
161132
162-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
133+
### 💻 Developing
163134
164-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
135+
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!
136+
Hit us up in [Slack][slack], in the `#cloudposse` channel.
165137

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

168-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
169-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
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.
146+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
178147

179-
## Slack Community
148+
### 🌎 Slack Community
180149

181150
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.
182151

183-
## Discourse Forums
184-
185-
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.
186-
187-
## Newsletter
152+
### 📰 Newsletter
188153

189-
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.
154+
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.
155+
Dropped straight into your Inbox every week — and usually a 5-minute read.
190156

191-
## Office Hours
157+
### 📆 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" />
192158

193-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
159+
[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.
160+
It's **FREE** for everyone!
194161

195-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
196-
197-
## Contributing
198-
199-
### Bug Reports & Feature Requests
200-
201-
Please use the [issue tracker](https://github.com/cloudposse/github-action-spacelift-stack-deploy/issues) to report any bugs or file feature requests.
202-
203-
### Developing
204-
205-
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].
206-
207-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
162+
## About
208163

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

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

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

218-
## Copyright
173+
*Your team can operate like a pro today.*
219174

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

177+
<details>
178+
<summary>📚 <strong>What's included?</strong></summary>
222179

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

192+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
224193
## License
225194

226-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
227-
228-
See [LICENSE](LICENSE) for full details.
195+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
229196

197+
<details>
198+
<summary>Preamble to the Apache License, Version 2.0</summary>
199+
<br/>
200+
<br/>
201+
Complete license is available in the [`LICENSE`](LICENSE) file.
230202
```text
231203
Licensed to the Apache Software Foundation (ASF) under one
232204
or more contributor license agreements. See the NOTICE file
@@ -245,43 +217,13 @@ KIND, either express or implied. See the License for the
245217
specific language governing permissions and limitations
246218
under the License.
247219
```
248-
249-
250-
251-
252-
253-
254-
255-
220+
</details>
256221

257222
## Trademarks
258223

259224
All other trademarks referenced herein are the property of their respective owners.
260-
261-
## About
262-
263-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
264-
265-
[![Cloud Posse][logo]][website]
266-
267-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
268-
269-
We offer [paid support][commercial_support] on all of our projects.
270-
271-
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.
272-
273-
274-
275-
### Contributors
276-
277-
<!-- markdownlint-disable -->
278-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
279-
|---|
280-
<!-- markdownlint-restore -->
281-
282-
[goruha_homepage]: https://github.com/goruha
283-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
284-
225+
---
226+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
285227
[![README Footer][readme_footer_img]][readme_footer_link]
286228
[![Beacon][beacon]][website]
287229
<!-- markdownlint-disable -->
@@ -292,12 +234,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
292234
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=jobs
293235
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=hire
294236
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=slack
295-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=linkedin
296237
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=twitter
297-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=testimonial
298238
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=office_hours
299239
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=newsletter
300-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=discourse
301240
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=email
302241
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=commercial_support
303242
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=we_love_open_source
@@ -308,11 +247,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
308247
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=readme_footer_link
309248
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
310249
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-spacelift-stack-deploy&utm_content=readme_commercial_support_link
311-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-spacelift-stack-deploy&url=https://github.com/cloudposse/github-action-spacelift-stack-deploy
312-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-spacelift-stack-deploy&url=https://github.com/cloudposse/github-action-spacelift-stack-deploy
313-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-spacelift-stack-deploy
314-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-spacelift-stack-deploy
315-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-spacelift-stack-deploy
316-
[share_email]: mailto:?subject=github-action-spacelift-stack-deploy&body=https://github.com/cloudposse/github-action-spacelift-stack-deploy
317250
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-spacelift-stack-deploy?pixel&cs=github&cm=readme&an=github-action-spacelift-stack-deploy
318251
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)