Skip to content

Commit b0105c1

Browse files
authored
Update README.md and docs
1 parent 19e3aed commit b0105c1

File tree

2 files changed

+42
-110
lines changed

2 files changed

+42
-110
lines changed

README.md

Lines changed: 41 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,6 @@ Get Environments settings from private settings action provider
3535
---
3636

3737
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-
4638

4739

4840
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
@@ -64,8 +56,6 @@ Get Environments settings from private settings action provider.
6456

6557

6658

67-
68-
6959
## Usage
7060

7161

@@ -131,19 +121,11 @@ Get Environments settings from private settings action provider.
131121
| namespace | Namespace |
132122
| region | JSON formatted {label}: {environment} map |
133123
| role | Environments that need to be deployed |
124+
| s3-bucket | S3 Bucket for ECS taskdef mirroring |
134125
| ssm-path | Path to ssm secrets |
135126
<!-- markdownlint-restore -->
136127
137128
138-
139-
## Share the Love
140-
141-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-interface-environment)! (it helps us **a lot**)
142-
143-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
144-
145-
146-
147129
## Related Projects
148130
149131
Check out these related projects.
@@ -158,81 +140,70 @@ For additional context, refer to some of these links.
158140
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
159141
160142
161-
## Help
162-
163-
**Got a question?** We got answers.
143+
## ✨ Contributing
164144
165-
File a GitHub [issue](https://github.com/cloudposse/github-action-interface-environment/issues), send us an [email][email] or join our [Slack Community][slack].
145+
This project is under active development, and we encourage contributions from our community.
146+
Many thanks to our outstanding contributors:
166147
167-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
148+
<a href="https://github.com/cloudposse/github-action-interface-environment/graphs/contributors">
149+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-interface-environment&max=24" />
150+
</a>
168151
169-
## DevOps Accelerator for Startups
152+
### 🐛 Bug Reports & Feature Requests
170153
154+
Please use the [issue tracker](https://github.com/cloudposse/github-action-interface-environment/issues) to report any bugs or file feature requests.
171155
172-
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.
156+
### 💻 Developing
173157
174-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
158+
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].
175159
176-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
160+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
177161
178-
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.
162+
1. **Fork** the repo on GitHub
163+
2. **Clone** the project to your own machine
164+
3. **Commit** changes to your own branch
165+
4. **Push** your work back up to your fork
166+
5. Submit a **Pull Request** so that we can review your changes
179167
180-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
181-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
182-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
183-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
184-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
185-
- **Training.** You'll receive hands-on training so your team can operate what we build.
186-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
187-
- **Troubleshooting.** You'll get help to triage when things aren't working.
188-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
189-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
168+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
190169
191-
## Slack Community
170+
### 🌎 Slack Community
192171
193172
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.
194173
195-
## Discourse Forums
196-
197-
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.
198-
199-
## Newsletter
174+
### 📰 Newsletter
200175
201176
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.
202177
203-
## Office Hours
178+
### 📆 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" />
204179
205180
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
206181
207-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
208-
209-
## Contributing
210-
211-
### Bug Reports & Feature Requests
182+
## About
212183
213-
Please use the [issue tracker](https://github.com/cloudposse/github-action-interface-environment/issues) to report any bugs or file feature requests.
214-
215-
### Developing
216-
217-
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].
218-
219-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
220-
221-
1. **Fork** the repo on GitHub
222-
2. **Clone** the project to your own machine
223-
3. **Commit** changes to your own branch
224-
4. **Push** your work back up to your fork
225-
5. Submit a **Pull Request** so that we can review your changes
226-
227-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
184+
This project is maintained and funded by [Cloud Posse, LLC][website].
185+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
228186
187+
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.
229188
230-
## Copyright
189+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
231190
232-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
191+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
233192
193+
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.
234194
195+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
196+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
197+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
198+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
199+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
200+
- **Training.** You'll receive hands-on training so your team can operate what we build.
201+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
202+
- **Troubleshooting.** You'll get help to triage when things aren't working.
203+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
204+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
235205
206+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
236207
## License
237208
238209
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -258,42 +229,11 @@ specific language governing permissions and limitations
258229
under the License.
259230
```
260231

261-
262-
263-
264-
265-
266-
267-
268-
269232
## Trademarks
270233

271234
All other trademarks referenced herein are the property of their respective owners.
272-
273-
## About
274-
275-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
276-
277-
[![Cloud Posse][logo]][website]
278-
279-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
280-
281-
We offer [paid support][commercial_support] on all of our projects.
282-
283-
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.
284-
285-
286-
287-
### Contributors
288-
289-
<!-- markdownlint-disable -->
290-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
291-
|---|
292-
<!-- markdownlint-restore -->
293-
294-
[goruha_homepage]: https://github.com/goruha
295-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
296-
235+
---
236+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
297237
[![README Footer][readme_footer_img]][readme_footer_link]
298238
[![Beacon][beacon]][website]
299239
<!-- markdownlint-disable -->
@@ -304,12 +244,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
304244
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=jobs
305245
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=hire
306246
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=slack
307-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=linkedin
308247
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=twitter
309-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=testimonial
310248
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=office_hours
311249
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=newsletter
312-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=discourse
313250
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=email
314251
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=commercial_support
315252
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=we_love_open_source
@@ -320,11 +257,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
320257
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=readme_footer_link
321258
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
322259
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=readme_commercial_support_link
323-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-interface-environment&url=https://github.com/cloudposse/github-action-interface-environment
324-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-interface-environment&url=https://github.com/cloudposse/github-action-interface-environment
325-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-interface-environment
326-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-interface-environment
327-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-interface-environment
328-
[share_email]: mailto:?subject=github-action-interface-environment&body=https://github.com/cloudposse/github-action-interface-environment
329260
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-interface-environment?pixel&cs=github&cm=readme&an=github-action-interface-environment
330261
<!-- markdownlint-restore -->

docs/github-action.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@
2424
| namespace | Namespace |
2525
| region | JSON formatted {label}: {environment} map |
2626
| role | Environments that need to be deployed |
27+
| s3-bucket | S3 Bucket for ECS taskdef mirroring |
2728
| ssm-path | Path to ssm secrets |
2829
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)