Skip to content

Commit 9ac217b

Browse files
Update README.md and docs (#17)
Co-authored-by: goruha <[email protected]>
1 parent 7f8f4d9 commit 9ac217b

File tree

1 file changed

+37
-162
lines changed

1 file changed

+37
-162
lines changed

README.md

Lines changed: 37 additions & 162 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# github-action-yaml-config-query [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg)](https://github.com/cloudposse/github-action-yaml-config-query/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4+
# github-action-yaml-config-query <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
<a href="https://github.com/cloudposse/github-action-yaml-config-query/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
46
<!-- markdownlint-restore -->
57

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
108
<!--
119
1210
1311
1412
1513
** DO NOT EDIT THIS FILE
1614
**
17-
** This file was automatically generated by the `build-harness`.
15+
** This file was automatically generated by the `cloudposse/build-harness`.
1816
** 1) Make all changes to `README.yaml`
1917
** 2) Run `make init` (you only need to do this once)
2018
** 3) Run`make readme` to rebuild this file.
@@ -30,29 +28,6 @@
3028

3129
Define YAML document, filter it with JSON query and get result as outputs
3230

33-
---
34-
35-
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-
44-
45-
46-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
47-
48-
49-
50-
51-
52-
53-
54-
55-
5631

5732

5833

@@ -67,11 +42,8 @@ For examples follow [usage](#usage) section.
6742

6843

6944

70-
7145
## Usage
7246

73-
74-
7547
### Define constants
7648
```yaml
7749
name: Pull Request
@@ -212,15 +184,6 @@ For examples follow [usage](#usage) section.
212184
<!-- markdownlint-restore -->
213185
214186
215-
216-
## Share the Love
217-
218-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-yaml-config-query)! (it helps us **a lot**)
219-
220-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
221-
222-
223-
224187
## Related Projects
225188
226189
Check out these related projects.
@@ -235,86 +198,55 @@ For additional context, refer to some of these links.
235198
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
236199
237200
238-
## Help
239-
240-
**Got a question?** We got answers.
241-
242-
File a GitHub [issue](https://github.com/cloudposse/github-action-yaml-config-query/issues), send us an [email][email] or join our [Slack Community][slack].
243-
244-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
245-
246-
## DevOps Accelerator for Startups
247-
248-
249-
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.
250201
251-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
252202
253-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
203+
## ✨ Contributing
254204
255-
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.
205+
This project is under active development, and we encourage contributions from our community.
256206
257-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
258-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
259-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
260-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
261-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
262-
- **Training.** You'll receive hands-on training so your team can operate what we build.
263-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
264-
- **Troubleshooting.** You'll get help to triage when things aren't working.
265-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
266-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
267207
268-
## Slack Community
269208
270-
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.
209+
Many thanks to our outstanding contributors:
271210
272-
## Discourse Forums
211+
<a href="https://github.com/cloudposse/github-action-yaml-config-query/graphs/contributors">
212+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-yaml-config-query&max=24" />
213+
</a>
273214
274-
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.
275-
276-
## Newsletter
277-
278-
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.
279-
280-
## Office Hours
281-
282-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
283-
284-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
285-
286-
## Contributing
287-
288-
### Bug Reports & Feature Requests
289-
290-
Please use the [issue tracker](https://github.com/cloudposse/github-action-yaml-config-query/issues) to report any bugs or file feature requests.
291-
292-
### Developing
293-
294-
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].
215+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-yaml-config-query/issues).
295216
296217
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
297-
298-
1. **Fork** the repo on GitHub
299-
2. **Clone** the project to your own machine
300-
3. **Commit** changes to your own branch
301-
4. **Push** your work back up to your fork
302-
5. Submit a **Pull Request** so that we can review your changes
218+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-yaml-config-query/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
219+
2. **Fork** the repo on GitHub
220+
3. **Clone** the project to your own machine
221+
4. **Commit** changes to your own branch
222+
5. **Push** your work back up to your fork
223+
6. Submit a **Pull Request** so that we can review your changes
303224
304225
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
305226
227+
### 🌎 Slack Community
306228
307-
## Copyright
229+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&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.
308230
309-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
231+
### 📰 Newsletter
310232
233+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&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.
234+
Dropped straight into your Inbox every week — and usually a 5-minute read.
311235
236+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&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>
312237
238+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&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.
239+
It's **FREE** for everyone!
313240
## License
314241
315-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
242+
<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>
243+
244+
<details>
245+
<summary>Preamble to the Apache License, Version 2.0</summary>
246+
<br/>
247+
<br/>
316248
317-
See [LICENSE](LICENSE) for full details.
249+
Complete license is available in the [`LICENSE`](LICENSE) file.
318250

319251
```text
320252
Licensed to the Apache Software Foundation (ASF) under one
@@ -334,74 +266,17 @@ KIND, either express or implied. See the License for the
334266
specific language governing permissions and limitations
335267
under the License.
336268
```
337-
338-
339-
340-
341-
342-
343-
344-
269+
</details>
345270

346271
## Trademarks
347272

348273
All other trademarks referenced herein are the property of their respective owners.
349274

350-
## About
351-
352-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
353-
354-
[![Cloud Posse][logo]][website]
355-
356-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
357-
358-
We offer [paid support][commercial_support] on all of our projects.
359275

360-
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.
361-
362-
363-
364-
### Contributors
276+
---
277+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
365278

366-
<!-- markdownlint-disable -->
367-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
368-
|---|
369-
<!-- markdownlint-restore -->
370279

371-
[goruha_homepage]: https://github.com/goruha
372-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
280+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
373281

374-
[![README Footer][readme_footer_img]][readme_footer_link]
375-
[![Beacon][beacon]][website]
376-
<!-- markdownlint-disable -->
377-
[logo]: https://cloudposse.com/logo-300x69.svg
378-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=docs
379-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=website
380-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=github
381-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=jobs
382-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=hire
383-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=slack
384-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=linkedin
385-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=twitter
386-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=testimonial
387-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=office_hours
388-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=newsletter
389-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=discourse
390-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=email
391-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=commercial_support
392-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=we_love_open_source
393-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=terraform_modules
394-
[readme_header_img]: https://cloudposse.com/readme/header/img
395-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=readme_header_link
396-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
397-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=readme_footer_link
398-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
399-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content=readme_commercial_support_link
400-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-yaml-config-query&url=https://github.com/cloudposse/github-action-yaml-config-query
401-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-yaml-config-query&url=https://github.com/cloudposse/github-action-yaml-config-query
402-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-yaml-config-query
403-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-yaml-config-query
404-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-yaml-config-query
405-
[share_email]: mailto:?subject=github-action-yaml-config-query&body=https://github.com/cloudposse/github-action-yaml-config-query
406-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-yaml-config-query?pixel&cs=github&cm=readme&an=github-action-yaml-config-query
407-
<!-- markdownlint-restore -->
282+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-yaml-config-query?pixel&cs=github&cm=readme&an=github-action-yaml-config-query"/>

0 commit comments

Comments
 (0)