Skip to content

Commit c8a4e57

Browse files
authored
Update README.md and docs
1 parent a74039f commit c8a4e57

File tree

2 files changed

+41
-88
lines changed

2 files changed

+41
-88
lines changed

README.md

Lines changed: 40 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# github-action-deploy-argocd<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a> [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-deploy-argocd.svg)](https://github.com/cloudposse/github-action-deploy-argocd/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4+
# github-action-deploy-argocd <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
<a href="https://github.com/cloudposse/github-action-deploy-argocd/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-deploy-argocd.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-
78
<!--
89
910
1011
1112
1213
** DO NOT EDIT THIS FILE
1314
**
14-
** This file was automatically generated by the `build-harness`.
15+
** This file was automatically generated by the `cloudposse/build-harness`.
1516
** 1) Make all changes to `README.yaml`
1617
** 2) Run `make init` (you only need to do this once)
1718
** 3) Run`make readme` to rebuild this file.
@@ -27,16 +28,6 @@
2728

2829
Deploy on Kubernetes with ArgoCD
2930

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

4132

4233

@@ -46,9 +37,8 @@ Deploy on Kubernetes with Helm/HelmFile and ArgoCD.
4637

4738

4839

49-
## Usage
50-
5140

41+
## Usage
5242

5343
Deploy environment
5444
```yaml
@@ -161,7 +151,7 @@ Destroy environment
161151
| ssm-path | SSM path to read environment secrets | N/A | true |
162152
| synchronously | Wait until ArgoCD successfully apply the changes | false | false |
163153
| toolchain | Toolchain ('helm', 'helmfile') | helmfile | false |
164-
| values\_file | Helmfile values file | | false |
154+
| values\_file | Helm values file, this can be a single file or a comma separated list of files | | false |
165155

166156

167157
## Outputs
@@ -186,75 +176,55 @@ For additional context, refer to some of these links.
186176
- [github-actions-workflows](https://github.com/cloudposse/github-actions-workflows) - Reusable workflows for different types of projects
187177

188178

179+
180+
189181
## ✨ Contributing
190182

191-
This project is under active development, and we encourage contributions from our community.
183+
This project is under active development, and we encourage contributions from our community.
184+
185+
186+
192187
Many thanks to our outstanding contributors:
193188

194189
<a href="https://github.com/cloudposse/github-action-deploy-argocd/graphs/contributors">
195190
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-deploy-argocd&max=24" />
196191
</a>
197192

198-
### 🐛 Bug Reports & Feature Requests
199-
200-
Please use the [issue tracker](https://github.com/cloudposse/github-action-deploy-argocd/issues) to report any bugs or file feature requests.
201-
202-
### 💻 Developing
203-
204-
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].
193+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-deploy-argocd/issues).
205194

206195
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
207-
208-
1. **Fork** the repo on GitHub
209-
2. **Clone** the project to your own machine
210-
3. **Commit** changes to your own branch
211-
4. **Push** your work back up to your fork
212-
5. Submit a **Pull Request** so that we can review your changes
196+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-deploy-argocd/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
197+
2. **Fork** the repo on GitHub
198+
3. **Clone** the project to your own machine
199+
4. **Commit** changes to your own branch
200+
5. **Push** your work back up to your fork
201+
6. Submit a **Pull Request** so that we can review your changes
213202

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

216205
### 🌎 Slack Community
217206

218-
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.
207+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&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.
219208

220209
### 📰 Newsletter
221210

222-
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.
223-
224-
### 📆 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" />
225-
226-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
227-
228-
## About
229-
230-
This project is maintained and funded by [Cloud Posse, LLC][website].
231-
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
232-
233-
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.
234-
235-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
236-
237-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
238-
239-
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.
211+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&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.
212+
Dropped straight into your Inbox every week — and usually a 5-minute read.
240213

241-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
242-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
243-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
244-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
245-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
246-
- **Training.** You'll receive hands-on training so your team can operate what we build.
247-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
248-
- **Troubleshooting.** You'll get help to triage when things aren't working.
249-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
250-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
214+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&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>
251215

252-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
216+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&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.
217+
It's **FREE** for everyone!
253218
## License
254219

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

257-
See [LICENSE](LICENSE) for full details.
222+
<details>
223+
<summary>Preamble to the Apache License, Version 2.0</summary>
224+
<br/>
225+
<br/>
226+
227+
Complete license is available in the [`LICENSE`](LICENSE) file.
258228

259229
```text
260230
Licensed to the Apache Software Foundation (ASF) under one
@@ -274,34 +244,17 @@ KIND, either express or implied. See the License for the
274244
specific language governing permissions and limitations
275245
under the License.
276246
```
247+
</details>
277248

278249
## Trademarks
279250

280251
All other trademarks referenced herein are the property of their respective owners.
252+
253+
281254
---
282255
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
283-
[![README Footer][readme_footer_img]][readme_footer_link]
284-
[![Beacon][beacon]][website]
285-
<!-- markdownlint-disable -->
286-
[logo]: https://cloudposse.com/logo-300x69.svg
287-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=docs
288-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=website
289-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=github
290-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=jobs
291-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=hire
292-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=slack
293-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=twitter
294-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=office_hours
295-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=newsletter
296-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=email
297-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=commercial_support
298-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=we_love_open_source
299-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=terraform_modules
300-
[readme_header_img]: https://cloudposse.com/readme/header/img
301-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=readme_header_link
302-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
303-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=readme_footer_link
304-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
305-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=readme_commercial_support_link
306-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-deploy-argocd?pixel&cs=github&cm=readme&an=github-action-deploy-argocd
307-
<!-- markdownlint-restore -->
256+
257+
258+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-deploy-argocd&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
259+
260+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-deploy-argocd?pixel&cs=github&cm=readme&an=github-action-deploy-argocd"/>

docs/github-action.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
| ssm-path | SSM path to read environment secrets | N/A | true |
2525
| synchronously | Wait until ArgoCD successfully apply the changes | false | false |
2626
| toolchain | Toolchain ('helm', 'helmfile') | helmfile | false |
27-
| values\_file | Helmfile values file | | false |
27+
| values\_file | Helm values file, this can be a single file or a comma separated list of files | | false |
2828

2929

3030
## Outputs

0 commit comments

Comments
 (0)