Skip to content

Commit 8fa43a0

Browse files
authored
Update README.md and docs
1 parent 42766f4 commit 8fa43a0

File tree

2 files changed

+44
-110
lines changed

2 files changed

+44
-110
lines changed

README.md

Lines changed: 42 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

@@ -114,6 +104,7 @@ Get Environments settings from private settings action provider.
114104
| application | Application name | N/A | false |
115105
| attributes | Comma separated attributes | N/A | false |
116106
| environment | Environment name | N/A | true |
107+
| implementation\_file | Repository filename with Environment action implementation | action.yaml | true |
117108
| implementation\_github\_pat | GitHub PAT allow fetch environment action implementation | N/A | true |
118109
| implementation\_path | Repository path with Environment action implementation | | true |
119110
| implementation\_ref | Ref of environment action implementation | main | true |
@@ -131,19 +122,11 @@ Get Environments settings from private settings action provider.
131122
| namespace | Namespace |
132123
| region | JSON formatted {label}: {environment} map |
133124
| role | Environments that need to be deployed |
125+
| s3-bucket | S3 Bucket for ECS taskdef mirroring |
134126
| ssm-path | Path to ssm secrets |
135127
<!-- markdownlint-restore -->
136128
137129
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-
147130
## Related Projects
148131
149132
Check out these related projects.
@@ -158,81 +141,70 @@ For additional context, refer to some of these links.
158141
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
159142
160143
161-
## Help
162-
163-
**Got a question?** We got answers.
144+
## ✨ Contributing
164145
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].
146+
This project is under active development, and we encourage contributions from our community.
147+
Many thanks to our outstanding contributors:
166148
167-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
149+
<a href="https://github.com/cloudposse/github-action-interface-environment/graphs/contributors">
150+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-interface-environment&max=24" />
151+
</a>
168152
169-
## DevOps Accelerator for Startups
153+
### 🐛 Bug Reports & Feature Requests
170154
155+
Please use the [issue tracker](https://github.com/cloudposse/github-action-interface-environment/issues) to report any bugs or file feature requests.
171156
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.
157+
### 💻 Developing
173158
174-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
159+
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].
175160
176-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
161+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
177162
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.
163+
1. **Fork** the repo on GitHub
164+
2. **Clone** the project to your own machine
165+
3. **Commit** changes to your own branch
166+
4. **Push** your work back up to your fork
167+
5. Submit a **Pull Request** so that we can review your changes
179168
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.
169+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
190170
191-
## Slack Community
171+
### 🌎 Slack Community
192172
193173
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.
194174
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
175+
### 📰 Newsletter
200176
201177
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.
202178
203-
## Office Hours
179+
### 📆 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" />
204180
205181
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
206182
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
183+
## About
212184
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!
185+
This project is maintained and funded by [Cloud Posse, LLC][website].
186+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
228187
188+
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.
229189
230-
## Copyright
190+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
231191
232-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
192+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
233193
194+
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.
234195
196+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
197+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
198+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
199+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
200+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
201+
- **Training.** You'll receive hands-on training so your team can operate what we build.
202+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
203+
- **Troubleshooting.** You'll get help to triage when things aren't working.
204+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
205+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
235206
207+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
236208
## License
237209
238210
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -258,42 +230,11 @@ specific language governing permissions and limitations
258230
under the License.
259231
```
260232

261-
262-
263-
264-
265-
266-
267-
268-
269233
## Trademarks
270234

271235
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-
236+
---
237+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
297238
[![README Footer][readme_footer_img]][readme_footer_link]
298239
[![Beacon][beacon]][website]
299240
<!-- markdownlint-disable -->
@@ -304,12 +245,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
304245
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=jobs
305246
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=hire
306247
[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
308248
[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
310249
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=office_hours
311250
[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
313251
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=email
314252
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=commercial_support
315253
[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 +258,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
320258
[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
321259
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
322260
[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
329261
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-interface-environment?pixel&cs=github&cm=readme&an=github-action-interface-environment
330262
<!-- markdownlint-restore -->

docs/github-action.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
| application | Application name | N/A | false |
88
| attributes | Comma separated attributes | N/A | false |
99
| environment | Environment name | N/A | true |
10+
| implementation\_file | Repository filename with Environment action implementation | action.yaml | true |
1011
| implementation\_github\_pat | GitHub PAT allow fetch environment action implementation | N/A | true |
1112
| implementation\_path | Repository path with Environment action implementation | | true |
1213
| implementation\_ref | Ref of environment action implementation | main | true |
@@ -24,5 +25,6 @@
2425
| namespace | Namespace |
2526
| region | JSON formatted {label}: {environment} map |
2627
| role | Environments that need to be deployed |
28+
| s3-bucket | S3 Bucket for ECS taskdef mirroring |
2729
| ssm-path | Path to ssm secrets |
2830
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)