Skip to content

Commit cb3f1d7

Browse files
authored
Update README.md and docs
1 parent 29b7ba5 commit cb3f1d7

File tree

2 files changed

+41
-109
lines changed

2 files changed

+41
-109
lines changed

README.md

+40-109
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,6 @@ A GitHub Action to get a list of affected atmos stacks for a pull request
3333
---
3434

3535
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-
4436

4537

4638
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -64,8 +56,6 @@ raw list of affected stacks as an output as well as a matrix that can be used fu
6456

6557

6658

67-
68-
6959
## Usage
7060

7161

@@ -102,6 +92,7 @@ raw list of affected stacks as an output as well as a matrix that can be used fu
10292
| Name | Description | Default | Required |
10393
|------|-------------|---------|----------|
10494
| atmos-config-path | The path to the atmos.yaml file | atmos.yaml | false |
95+
| atmos-include-spacelift-admin-stacks | Whether to include the Spacelift admin stacks of affected stacks in the output | false | false |
10596
| atmos-version | The version of atmos to install if install-atmos is true | latest | false |
10697
| default-branch | The default branch to use for the base ref. | ${{ github.event.repository.default\_branch }} | false |
10798
| head-ref | The head ref to checkout. If not provided, the head default branch is used. | N/A | false |
@@ -123,37 +114,61 @@ raw list of affected stacks as an output as well as a matrix that can be used fu
123114
<!-- markdownlint-restore -->
124115
125116
117+
## Related Projects
126118
127-
## Share the Love
119+
Check out these related projects.
128120
129-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-atmos-affected-stacks)! (it helps us **a lot**)
130121
131-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
132122
123+
## References
133124
125+
For additional context, refer to some of these links.
134126
135-
## Related Projects
136127
137-
Check out these related projects.
138128
129+
## ✨ Contributing
139130
131+
This project is under active development, and we encourage contributions from our community.
132+
Many thanks to our outstanding contributors:
140133
141-
## References
134+
<a href="https://github.com/cloudposse/github-action-atmos-affected-stacks/graphs/contributors">
135+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-affected-stacks&max=24" />
136+
</a>
142137
143-
For additional context, refer to some of these links.
138+
### 🐛 Bug Reports & Feature Requests
144139
140+
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-affected-stacks/issues) to report any bugs or file feature requests.
145141
142+
### 💻 Developing
146143
147-
## Help
144+
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].
148145
149-
**Got a question?** We got answers.
146+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
150147
151-
File a GitHub [issue](https://github.com/cloudposse/github-action-atmos-affected-stacks/issues), send us an [email][email] or join our [Slack Community][slack].
148+
1. **Fork** the repo on GitHub
149+
2. **Clone** the project to your own machine
150+
3. **Commit** changes to your own branch
151+
4. **Push** your work back up to your fork
152+
5. Submit a **Pull Request** so that we can review your changes
152153
153-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
154+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
155+
156+
### 🌎 Slack Community
154157
155-
## DevOps Accelerator for Startups
158+
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.
159+
160+
### 📰 Newsletter
161+
162+
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.
163+
164+
### 📆 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" />
165+
166+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
167+
168+
## About
156169
170+
This project is maintained and funded by [Cloud Posse, LLC][website].
171+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
157172
158173
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.
159174
@@ -174,51 +189,7 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
174189
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
175190
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
176191
177-
## Slack Community
178-
179-
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.
180-
181-
## Discourse Forums
182-
183-
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.
184-
185-
## Newsletter
186-
187-
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.
188-
189-
## Office Hours
190-
191-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
192-
193-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
194-
195-
## Contributing
196-
197-
### Bug Reports & Feature Requests
198-
199-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-affected-stacks/issues) to report any bugs or file feature requests.
200-
201-
### Developing
202-
203-
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].
204-
205-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
206-
207-
1. **Fork** the repo on GitHub
208-
2. **Clone** the project to your own machine
209-
3. **Commit** changes to your own branch
210-
4. **Push** your work back up to your fork
211-
5. Submit a **Pull Request** so that we can review your changes
212-
213-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
214-
215-
216-
## Copyright
217-
218-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
219-
220-
221-
192+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
222193
## License
223194
224195
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -244,42 +215,11 @@ specific language governing permissions and limitations
244215
under the License.
245216
```
246217

247-
248-
249-
250-
251-
252-
253-
254-
255218
## Trademarks
256219

257220
All other trademarks referenced herein are the property of their respective owners.
258-
259-
## About
260-
261-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
262-
263-
[![Cloud Posse][logo]][website]
264-
265-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
266-
267-
We offer [paid support][commercial_support] on all of our projects.
268-
269-
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.
270-
271-
272-
273-
### Contributors
274-
275-
<!-- markdownlint-disable -->
276-
| [![Matt Calhoun][mcalhoun_avatar]][mcalhoun_homepage]<br/>[Matt Calhoun][mcalhoun_homepage] |
277-
|---|
278-
<!-- markdownlint-restore -->
279-
280-
[mcalhoun_homepage]: https://github.com/mcalhoun
281-
[mcalhoun_avatar]: https://img.cloudposse.com/150x150/https://github.com/mcalhoun.png
282-
221+
---
222+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
283223
[![README Footer][readme_footer_img]][readme_footer_link]
284224
[![Beacon][beacon]][website]
285225
<!-- markdownlint-disable -->
@@ -290,12 +230,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
290230
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=jobs
291231
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=hire
292232
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=slack
293-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=linkedin
294233
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=twitter
295-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=testimonial
296234
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=office_hours
297235
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=newsletter
298-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=discourse
299236
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=email
300237
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=commercial_support
301238
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=we_love_open_source
@@ -306,11 +243,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
306243
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=readme_footer_link
307244
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
308245
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-affected-stacks&utm_content=readme_commercial_support_link
309-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-atmos-affected&url=https://github.com/cloudposse/github-action-atmos-affected-stacks
310-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-atmos-affected&url=https://github.com/cloudposse/github-action-atmos-affected-stacks
311-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-atmos-affected-stacks
312-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-atmos-affected-stacks
313-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-atmos-affected-stacks
314-
[share_email]: mailto:?subject=github-action-atmos-affected&body=https://github.com/cloudposse/github-action-atmos-affected-stacks
315246
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-affected-stacks?pixel&cs=github&cm=readme&an=github-action-atmos-affected-stacks
316247
<!-- markdownlint-restore -->

docs/github-action.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
| Name | Description | Default | Required |
66
|------|-------------|---------|----------|
77
| atmos-config-path | The path to the atmos.yaml file | atmos.yaml | false |
8+
| atmos-include-spacelift-admin-stacks | Whether to include the Spacelift admin stacks of affected stacks in the output | false | false |
89
| atmos-version | The version of atmos to install if install-atmos is true | latest | false |
910
| default-branch | The default branch to use for the base ref. | ${{ github.event.repository.default\_branch }} | false |
1011
| head-ref | The head ref to checkout. If not provided, the head default branch is used. | N/A | false |

0 commit comments

Comments
 (0)