Skip to content

Commit 46e3960

Browse files
authored
Added atmos readme (#116)
1 parent 24888ab commit 46e3960

File tree

4 files changed

+61
-170
lines changed

4 files changed

+61
-170
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ dist/bin
1919
.build-harness
2020

2121
.build-harness
22-
build-harness
22+
build-harness
23+
.atmos

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@ export DOCKER_IMAGE_NAME ?= $(DOCKER_IMAGE):$(DOCKER_TAG)
77
export DOCKER_BUILD_FLAGS =
88

99
-include $(shell curl -sSL -o .build-harness "https://cloudposse.tools/build-harness"; echo .build-harness)
10+
11+
readme:
12+
@atmos readme
13+
14+
readme/build:
15+
@atmos readme

README.md

Lines changed: 41 additions & 169 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# github-commenter [![Build Status](https://github.com/cloudposse/github-commenter/workflows/go/badge.svg?branch=master)](https://github.com/cloudposse/github-commenter/actions) [![Docker Status](https://github.com/cloudposse/github-commenter/workflows/docker/badge.svg?branch=master)](https://github.com/cloudposse/github-commenter/actions) [![Latest Release](https://img.shields.io/github/release/cloudposse/github-commenter.svg)](https://github.com/cloudposse/github-commenter/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4-
<!-- markdownlint-restore -->
4+
# github-commenter <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
56

6-
[![README Header][readme_header_img]][readme_header_link]
7+
<a href="https://github.com/cloudposse/github-commenter/actions"><img src="https://github.com/cloudposse/github-commenter/workflows/go/badge.svg?branch=master" alt="Build Status"/></a><a href="https://github.com/cloudposse/github-commenter/actions"><img src="https://github.com/cloudposse/github-commenter/workflows/docker/badge.svg?branch=master" alt="Docker Status"/></a><a href="https://github.com/cloudposse/github-commenter/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-commenter.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a><a href="https://cloudposse.com/support/"><img src="https://img.shields.io/badge/Get_Support-success.svg?style=for-the-badge" alt="Get Support"/></a>
78

8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9+
10+
<!-- markdownlint-restore -->
911

1012
<!--
1113
@@ -14,7 +16,7 @@
1416
1517
** DO NOT EDIT THIS FILE
1618
**
17-
** This file was automatically generated by the `build-harness`.
19+
** This file was automatically generated by the `cloudposse/build-harness`.
1820
** 1) Make all changes to `README.yaml`
1921
** 2) Run `make init` (you only need to do this once)
2022
** 3) Run`make readme` to rebuild this file.
@@ -42,35 +44,10 @@ Since GitHub considers Pull Requests as Issues, `Comments on Issues` and `Commen
4244

4345
The utility supports all these types of comments (`commit`, `pr-review`, `pr-file`, `issue`, `pr`).
4446

45-
---
46-
47-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
48-
[<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]
49-
[<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]
50-
[<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]
51-
[<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]
52-
[<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]
53-
[<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]
54-
55-
56-
57-
58-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
59-
60-
61-
62-
63-
64-
65-
66-
67-
68-
6947
## Screenshots
7048

49+
<img src="images/github-pr-review-comment.png" alt="PR" />*GitHub PR Review Comment*
7150

72-
![PR](images/github-pr-review-comment.png)
73-
*GitHub PR Review Comment*
7451

7552

7653

@@ -79,8 +56,6 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
7956

8057
## Usage
8158

82-
83-
8459
__NOTE__: Create a [GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) with `repo:status` and `public_repo` scopes.
8560

8661
__NOTE__: The utility accepts parameters as command-line arguments or as ENV variables (or any combination of command-line arguments and ENV vars).
@@ -133,7 +108,6 @@ GITHUB_COMMENT_FORMAT="Helm diff:<br><br><pre>{{regexReplaceAllLiteral `\\n` . `
133108

134109

135110

136-
137111
## Examples
138112

139113
The utility can be called directly or as a Docker container.
@@ -308,11 +282,7 @@ The `-edit-comment-regex` flag operates similarly to the `-delete-comment-regex`
308282

309283

310284

311-
## Share the Love
312-
313-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-commenter)! (it helps us **a lot**)
314285

315-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
316286

317287

318288

@@ -323,86 +293,55 @@ Check out these related projects.
323293
- [github-status-updater](https://github.com/cloudposse/github-status-updater) - Command line utility for updating GitHub commit statuses and enabling required status checks for pull requests
324294
- [slack-notifier](https://github.com/cloudposse/slack-notifier) - Command line utility to send messages with attachments to Slack channels via Incoming Webhooks
325295

326-
## Help
327-
328-
**Got a question?** We got answers.
329-
330-
File a GitHub [issue](https://github.com/cloudposse/github-commenter/issues), send us an [email][email] or join our [Slack Community][slack].
331-
332-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
333-
334-
## DevOps Accelerator for Startups
335-
336-
337-
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.
338-
339-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
340-
341-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
342-
343-
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.
344-
345-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
346-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
347-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
348-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
349-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
350-
- **Training.** You'll receive hands-on training so your team can operate what we build.
351-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
352-
- **Troubleshooting.** You'll get help to triage when things aren't working.
353-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
354-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
355296

356-
## Slack Community
357297

358-
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.
298+
## ✨ Contributing
359299

360-
## Discourse Forums
300+
This project is under active development, and we encourage contributions from our community.
361301

362-
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.
363302

364-
## Newsletter
365303

366-
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.
304+
Many thanks to our outstanding contributors:
367305

368-
## Office Hours
306+
<a href="https://github.com/cloudposse/github-commenter/graphs/contributors">
307+
<img src="https://contrib.rocks/image?repo=cloudposse/github-commenter&max=24" />
308+
</a>
369309

370-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
371-
372-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
373-
374-
## Contributing
375-
376-
### Bug Reports & Feature Requests
377-
378-
Please use the [issue tracker](https://github.com/cloudposse/github-commenter/issues) to report any bugs or file feature requests.
379-
380-
### Developing
381-
382-
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].
310+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-commenter/issues).
383311

384312
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
385-
386-
1. **Fork** the repo on GitHub
387-
2. **Clone** the project to your own machine
388-
3. **Commit** changes to your own branch
389-
4. **Push** your work back up to your fork
390-
5. Submit a **Pull Request** so that we can review your changes
313+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-commenter/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
314+
2. **Fork** the repo on GitHub
315+
3. **Clone** the project to your own machine
316+
4. **Commit** changes to your own branch
317+
5. **Push** your work back up to your fork
318+
6. Submit a **Pull Request** so that we can review your changes
391319

392320
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
393321

322+
### 🌎 Slack Community
394323

395-
## Copyright
324+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&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.
396325

397-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
326+
### 📰 Newsletter
398327

328+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&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.
329+
Dropped straight into your Inbox every week — and usually a 5-minute read.
399330

331+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&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>
400332

333+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&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.
334+
It's **FREE** for everyone!
401335
## License
402336

403-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
337+
<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>
404338

405-
See [LICENSE](LICENSE) for full details.
339+
<details>
340+
<summary>Preamble to the Apache License, Version 2.0</summary>
341+
<br/>
342+
<br/>
343+
344+
Complete license is available in the [`LICENSE`](LICENSE) file.
406345

407346
```text
408347
Licensed to the Apache Software Foundation (ASF) under one
@@ -422,84 +361,17 @@ KIND, either express or implied. See the License for the
422361
specific language governing permissions and limitations
423362
under the License.
424363
```
425-
426-
427-
428-
429-
430-
431-
432-
364+
</details>
433365

434366
## Trademarks
435367

436368
All other trademarks referenced herein are the property of their respective owners.
437369

438-
## About
439-
440-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
441-
442-
[![Cloud Posse][logo]][website]
443-
444-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
445-
446-
We offer [paid support][commercial_support] on all of our projects.
447-
448-
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.
449-
450-
451-
452-
### Contributors
453-
454-
<!-- markdownlint-disable -->
455-
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
456-
|---|---|---|
457-
<!-- markdownlint-restore -->
458-
459-
460-
[osterman_homepage]: https://github.com/osterman
461-
[osterman_avatar]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
462-
463-
464-
[aknysh_homepage]: https://github.com/aknysh/
465-
[aknysh_avatar]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
466370

371+
---
372+
Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
467373

468-
[goruha_homepage]: https://github.com/goruha/
469-
[goruha_avatar]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
470374

375+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
471376

472-
[![README Footer][readme_footer_img]][readme_footer_link]
473-
[![Beacon][beacon]][website]
474-
<!-- markdownlint-disable -->
475-
[logo]: https://cloudposse.com/logo-300x69.svg
476-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=docs
477-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=website
478-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=github
479-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=jobs
480-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=hire
481-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=slack
482-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=linkedin
483-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=twitter
484-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=testimonial
485-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=office_hours
486-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=newsletter
487-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=discourse
488-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=email
489-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=commercial_support
490-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=we_love_open_source
491-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=terraform_modules
492-
[readme_header_img]: https://cloudposse.com/readme/header/img
493-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=readme_header_link
494-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
495-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=readme_footer_link
496-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
497-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-commenter&utm_content=readme_commercial_support_link
498-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-commenter&url=https://github.com/cloudposse/github-commenter
499-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-commenter&url=https://github.com/cloudposse/github-commenter
500-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-commenter
501-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-commenter
502-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-commenter
503-
[share_email]: mailto:?subject=github-commenter&body=https://github.com/cloudposse/github-commenter
504-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-commenter?pixel&cs=github&cm=readme&an=github-commenter
505-
<!-- markdownlint-restore -->
377+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-commenter?pixel&cs=github&cm=readme&an=github-commenter"/>

atmos.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Atmos Configuration — powered by https://atmos.tools
2+
#
3+
# This configuration enables centralized, DRY, and consistent project scaffolding using Atmos.
4+
#
5+
# Included features:
6+
# - Organizational custom commands: https://atmos.tools/core-concepts/custom-commands
7+
# - Automated README generation: https://atmos.tools/cli/commands/docs/generate
8+
#
9+
10+
# Import shared configuration used by all modules
11+
import:
12+
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml

0 commit comments

Comments
 (0)