Skip to content

Commit 63f0e0f

Browse files
Update README.md and docs (#6)
Co-authored-by: zdmytriv <[email protected]>
1 parent b8e3152 commit 63f0e0f

File tree

3 files changed

+53
-136
lines changed

3 files changed

+53
-136
lines changed

README.md

Lines changed: 50 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11

22
<!-- markdownlint-disable -->
3-
# github-action-atmos-terraform-drift-detection
3+
# github-action-atmos-terraform-drift-detection<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
44

55
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-drift-detection.svg)](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
66
<!-- markdownlint-restore -->
77

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
118

129
<!--
1310
@@ -32,30 +29,15 @@
3229

3330
This Github Action is used to detect drift
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-
5732

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

6042

6143
## Introduction
@@ -70,8 +52,6 @@ There is another companion action [github-action-atmos-terraform-drift-remediati
7052

7153

7254

73-
74-
7555
## Usage
7656

7757

@@ -154,24 +134,15 @@ There is another companion action [github-action-atmos-terraform-drift-remediati
154134
|------|-------------|---------|----------|
155135
| assignee-teams | Comma-separated list of teams to assign issues to. You have to pass github token with `read:org` scope. This is used only when issue is getting created. | | false |
156136
| assignee-users | Comma-separated list of users to assign issues to. This is used only when issue is getting created. | | false |
157-
| debug | Enable action debug mode. Default: false | false | false |
158-
| issue-labels | Comma separated list of labels to add to the drift issues. Default: drift | drift | false |
137+
| labels | Comma-separated list of additional labels to assign issues to. | | false |
159138
| max-opened-issues | Number of open drift detection issues. Use `-1` to open unlimited number of issues. Default: 10 | 10 | false |
139+
| process-all | Process all issues or only the ones that relates to affected stacks. Default: false | false | false |
160140
| token | Used to pull node distributions for Atmos from Cloud Posse's GitHub repository. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ${{ github.server\_url == 'https://github.com' && github.token \|\| '' }} | false |
161141

162142

163143
<!-- markdownlint-restore -->
164144

165145

166-
167-
## Share the Love
168-
169-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection)! (it helps us **a lot**)
170-
171-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
172-
173-
174-
175146
## Related Projects
176147

177148
Check out these related projects.
@@ -189,81 +160,70 @@ For additional context, refer to some of these links.
189160
- [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) - A GitHub Action to securely store Terraform plan files in an S3 bucket with metadata storage in DynamoDB.
190161

191162

192-
## Help
163+
## ✨ Contributing
193164

194-
**Got a question?** We got answers.
165+
This project is under active development, and we encourage contributions from our community.
166+
Many thanks to our outstanding contributors:
195167

196-
File a GitHub [issue](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/issues), send us an [email][email] or join our [Slack Community][slack].
168+
<a href="https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/graphs/contributors">
169+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-terraform-drift-detection&max=24" />
170+
</a>
197171

198-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
199-
200-
## DevOps Accelerator for Startups
172+
### 🐛 Bug Reports & Feature Requests
201173

174+
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/issues) to report any bugs or file feature requests.
202175

203-
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.
176+
### 💻 Developing
204177

205-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
178+
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].
206179

207-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
180+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
208181

209-
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.
182+
1. **Fork** the repo on GitHub
183+
2. **Clone** the project to your own machine
184+
3. **Commit** changes to your own branch
185+
4. **Push** your work back up to your fork
186+
5. Submit a **Pull Request** so that we can review your changes
210187

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

222-
## Slack Community
190+
### 🌎 Slack Community
223191

224192
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.
225193

226-
## Discourse Forums
227-
228-
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.
229-
230-
## Newsletter
194+
### 📰 Newsletter
231195

232196
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.
233197

234-
## Office Hours
198+
### 📆 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" />
235199

236200
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
237201

238-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
239-
240-
## Contributing
202+
## About
241203

242-
### Bug Reports & Feature Requests
243-
244-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/issues) to report any bugs or file feature requests.
245-
246-
### Developing
247-
248-
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].
249-
250-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
251-
252-
1. **Fork** the repo on GitHub
253-
2. **Clone** the project to your own machine
254-
3. **Commit** changes to your own branch
255-
4. **Push** your work back up to your fork
256-
5. Submit a **Pull Request** so that we can review your changes
257-
258-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
204+
This project is maintained and funded by [Cloud Posse, LLC][website].
205+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
259206

207+
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.
260208

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

263-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
211+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
264212

213+
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.
265214

215+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
216+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
217+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
218+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
219+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
220+
- **Training.** You'll receive hands-on training so your team can operate what we build.
221+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
222+
- **Troubleshooting.** You'll get help to triage when things aren't working.
223+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
224+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
266225

226+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
267227
## License
268228

269229
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -289,46 +249,11 @@ specific language governing permissions and limitations
289249
under the License.
290250
```
291251

292-
293-
294-
295-
296-
297-
298-
299-
300252
## Trademarks
301253

302254
All other trademarks referenced herein are the property of their respective owners.
303-
304-
## About
305-
306-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
307-
308-
[![Cloud Posse][logo]][website]
309-
310-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
311-
312-
We offer [paid support][commercial_support] on all of our projects.
313-
314-
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.
315-
316-
317-
318-
### Contributors
319-
320-
<!-- markdownlint-disable -->
321-
| [![Zinovii Dmytriv][zdmytriv_avatar]][zdmytriv_homepage]<br/>[Zinovii Dmytriv][zdmytriv_homepage] | [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Daniel Miller][milldr_avatar]][milldr_homepage]<br/>[Daniel Miller][milldr_homepage] |
322-
|---|---|---|
323-
<!-- markdownlint-restore -->
324-
325-
[zdmytriv_homepage]: https://github.com/zdmytriv
326-
[zdmytriv_avatar]: https://img.cloudposse.com/150x150/https://github.com/zdmytriv.png
327-
[osterman_homepage]: https://github.com/osterman
328-
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
329-
[milldr_homepage]: https://github.com/milldr
330-
[milldr_avatar]: https://img.cloudposse.com/150x150/https://github.com/milldr.png
331-
255+
---
256+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
332257
[![README Footer][readme_footer_img]][readme_footer_link]
333258
[![Beacon][beacon]][website]
334259
<!-- markdownlint-disable -->
@@ -339,12 +264,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
339264
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=jobs
340265
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=hire
341266
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=slack
342-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=linkedin
343267
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=twitter
344-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=testimonial
345268
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=office_hours
346269
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=newsletter
347-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=discourse
348270
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=email
349271
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support
350272
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=we_love_open_source
@@ -355,11 +277,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
355277
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=readme_footer_link
356278
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
357279
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=readme_commercial_support_link
358-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-atmos-terraform-drift-detection&url=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
359-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-atmos-terraform-drift-detection&url=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
360-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
361-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
362-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
363-
[share_email]: mailto:?subject=github-action-atmos-terraform-drift-detection&body=https://github.com/cloudposse/github-action-atmos-terraform-drift-detection
364280
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-terraform-drift-detection?pixel&cs=github&cm=readme&an=github-action-atmos-terraform-drift-detection
365281
<!-- markdownlint-restore -->

build-harness

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 896b366ba4702d313293720d8a55489f2afdf9e9

docs/github-action.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
|------|-------------|---------|----------|
77
| assignee-teams | Comma-separated list of teams to assign issues to. You have to pass github token with `read:org` scope. This is used only when issue is getting created. | | false |
88
| assignee-users | Comma-separated list of users to assign issues to. This is used only when issue is getting created. | | false |
9-
| debug | Enable action debug mode. Default: false | false | false |
10-
| issue-labels | Comma separated list of labels to add to the drift issues. Default: drift | drift | false |
9+
| labels | Comma-separated list of additional labels to assign issues to. | | false |
1110
| max-opened-issues | Number of open drift detection issues. Use `-1` to open unlimited number of issues. Default: 10 | 10 | false |
11+
| process-all | Process all issues or only the ones that relates to affected stacks. Default: false | false | false |
1212
| token | Used to pull node distributions for Atmos from Cloud Posse's GitHub repository. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. | ${{ github.server\_url == 'https://github.com' && github.token \|\| '' }} | false |
1313

1414

0 commit comments

Comments
 (0)