diff --git a/.github/settings.yml b/.github/settings.yml index 267ae1e..013f89c 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -5,4 +5,3 @@ repository: description: Process a value with a jq script and output to a step output. homepage: https://cloudposse.com/accelerate topics: "" - diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml index d0477bf..91bc866 100644 --- a/.github/workflows/pre-commit.yaml +++ b/.github/workflows/pre-commit.yaml @@ -8,4 +8,4 @@ jobs: steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 - - uses: pre-commit/action@v2.0.0 + - uses: pre-commit/action@v3.0.1 diff --git a/.gitignore b/.gitignore index ed9108e..4ccaa9f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .build-harness build-harness +.atmos diff --git a/README.md b/README.md index bcdd24f..18e6f7a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ + -# github-action-jq [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-jq.svg)](https://github.com/cloudposse/github-action-jq/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) - +# github-action-jq + -[![README Header][readme_header_img]][readme_header_link] +Latest ReleaseSlack Community -[![Cloud Posse][logo]](https://cpco.io/homepage) + + - ## Inputs - + | Name | Description | Default | Required | |------|-------------|---------|----------| | compact | Compact instead of pretty-printed output | false | false | @@ -101,10 +75,11 @@ It's 100% Open Source and licensed under the [MIT](LICENSE). | raw-output | Output raw strings, not JSON texts | false | false | | remove-trailing-newline | Remove trailing newline | true | false | | script | JQ query string | N/A | true | + ## Outputs - + | Name | Description | |------|-------------| | output | Output from the jq command | @@ -112,13 +87,6 @@ It's 100% Open Source and licensed under the [MIT](LICENSE). -## Share the Love - -Like this project? Please give it a β˜… on [our GitHub](https://github.com/cloudposse/github-action-jq)! (it helps us **a lot**) - -Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =) - - ## Related Projects @@ -133,87 +101,48 @@ For additional context, refer to some of these links. - [github-action-atmos-matrix-unlimited](https://github.com/cloudposse/github-action-atmos-matrix-unlimited) - Group Atmos stacks and split each group into chunk of 256 items. Workaround of github action matrix limit -## Help - -**Got a question?** We got answers. - -File a GitHub [issue](https://github.com/cloudposse/github-action-jq/issues), send us an [email][email] or join our [Slack Community][slack]. -[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link] -## DevOps Accelerator for Startups +## ✨ Contributing +This project is under active development, and we encourage contributions from our community. -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. -[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support] -Work directly with our team of DevOps experts via email, slack, and video conferencing. +Many thanks to our outstanding contributors: -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. + + + -- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code. -- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments. -- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices. -- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes. -- **GitOps.** You'll be able to operate your infrastructure via Pull Requests. -- **Training.** You'll receive hands-on training so your team can operate what we build. -- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel. -- **Troubleshooting.** You'll get help to triage when things aren't working. -- **Code Reviews.** You'll receive constructive feedback on Pull Requests. -- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects. - -## Slack Community - -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. - -## Discourse Forums - -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. - -## Newsletter - -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. - -## Office Hours - -[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone! - -[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours] - -## Contributing - -### Bug Reports & Feature Requests - -Please use the [issue tracker](https://github.com/cloudposse/github-action-jq/issues) to report any bugs or file feature requests. - -### Developing - -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]. +For πŸ› bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-jq/issues). In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. - - 1. **Fork** the repo on GitHub - 2. **Clone** the project to your own machine - 3. **Commit** changes to your own branch - 4. **Push** your work back up to your fork - 5. Submit a **Pull Request** so that we can review your changes + 1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-jq/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md). + 2. **Fork** the repo on GitHub + 3. **Clone** the project to your own machine + 4. **Commit** changes to your own branch + 5. **Push** your work back up to your fork + 6. Submit a **Pull Request** so that we can review your changes **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! +### 🌎 Slack Community -## Copyright - -Copyright Β© 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright) - - +Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&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. +### πŸ“° Newsletter +Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&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. +Dropped straight into your Inbox every week β€” and usually a 5-minute read. +### πŸ“† Office Hours +[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&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. +It's **FREE** for everyone! ## License -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +License: MIT ```text The MIT License (MIT) @@ -239,72 +168,15 @@ THE SOFTWARE. Source: ``` - - - - - ## Trademarks All other trademarks referenced herein are the property of their respective owners. -## About - -This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]! - -[![Cloud Posse][logo]][website] - -We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❀️ [Open Source Software][we_love_open_source]. - -We offer [paid support][commercial_support] on all of our projects. -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. - - - -### Contributors +--- +Copyright Β© 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright) - -| [![Edward George][edwardgeorge_avatar]][edwardgeorge_homepage]
[Edward George][edwardgeorge_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] | -|---|---| - - [edwardgeorge_homepage]: https://github.com/edwardgeorge - [edwardgeorge_avatar]: https://img.cloudposse.com/150x150/https://github.com/edwardgeorge.png - [goruha_homepage]: https://github.com/goruha - [goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png +README footer -[![README Footer][readme_footer_img]][readme_footer_link] -[![Beacon][beacon]][website] - - [logo]: https://cloudposse.com/logo-300x69.svg - [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=docs - [website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=website - [github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=github - [jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=jobs - [hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=hire - [slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=slack - [linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=linkedin - [twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=twitter - [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=testimonial - [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=office_hours - [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=newsletter - [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=discourse - [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=email - [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=commercial_support - [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=we_love_open_source - [terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=terraform_modules - [readme_header_img]: https://cloudposse.com/readme/header/img - [readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=readme_header_link - [readme_footer_img]: https://cloudposse.com/readme/footer/img - [readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=readme_footer_link - [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img - [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-jq&utm_content=readme_commercial_support_link - [share_twitter]: https://twitter.com/intent/tweet/?text=github-action-jq&url=https://github.com/cloudposse/github-action-jq - [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-jq&url=https://github.com/cloudposse/github-action-jq - [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-jq - [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-jq - [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-jq - [share_email]: mailto:?subject=github-action-jq&body=https://github.com/cloudposse/github-action-jq - [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-jq?pixel&cs=github&cm=readme&an=github-action-jq - +Beacon diff --git a/README.yaml b/README.yaml index 9458e14..64a5b82 100644 --- a/README.yaml +++ b/README.yaml @@ -1,7 +1,7 @@ --- # # This is the canonical configuration for the `README.md` -# Run `make readme` to rebuild the `README.md` +# Run `atmos readme` to rebuild the `README.md` # name: github-action-jq @@ -54,8 +54,7 @@ usage: |- map(select(. == "test")) ``` -include: - - "docs/github-action.md" +include: [] # Contributors to this project contributors: diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29