Skip to content

Commit 77fb47e

Browse files
authored
Update README.md and docs
1 parent 42766f4 commit 77fb47e

File tree

2 files changed

+51
-125
lines changed

2 files changed

+51
-125
lines changed

README.md

Lines changed: 49 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11

22
<!-- markdownlint-disable -->
3-
# github-action-interface-environment
3+
# github-action-interface-environment<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
44

55
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-interface-environment.svg)](https://github.com/cloudposse/github-action-interface-environment/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
66
<!-- markdownlint-restore -->
77

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
118

129
<!--
1310
@@ -33,26 +30,13 @@
3330
Get Environments settings from private settings action provider
3431

3532
---
33+
> [!NOTE]
34+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
35+
>
36+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
37+
>
3638
37-
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-
46-
47-
48-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
49-
50-
51-
52-
53-
54-
55-
39+
[![README Header][readme_header_img]][readme_header_link]
5640

5741

5842

@@ -64,8 +48,6 @@ Get Environments settings from private settings action provider.
6448

6549

6650

67-
68-
6951
## Usage
7052

7153

@@ -114,6 +96,7 @@ Get Environments settings from private settings action provider.
11496
| application | Application name | N/A | false |
11597
| attributes | Comma separated attributes | N/A | false |
11698
| environment | Environment name | N/A | true |
99+
| implementation\_file | Repository filename with Environment action implementation | action.yaml | true |
117100
| implementation\_github\_pat | GitHub PAT allow fetch environment action implementation | N/A | true |
118101
| implementation\_path | Repository path with Environment action implementation | | true |
119102
| implementation\_ref | Ref of environment action implementation | main | true |
@@ -131,19 +114,11 @@ Get Environments settings from private settings action provider.
131114
| namespace | Namespace |
132115
| region | JSON formatted {label}: {environment} map |
133116
| role | Environments that need to be deployed |
117+
| s3-bucket | S3 Bucket for ECS taskdef mirroring |
134118
| ssm-path | Path to ssm secrets |
135119
<!-- markdownlint-restore -->
136120
137121
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-
147122
## Related Projects
148123
149124
Check out these related projects.
@@ -158,81 +133,70 @@ For additional context, refer to some of these links.
158133
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
159134
160135
161-
## Help
162-
163-
**Got a question?** We got answers.
136+
## ✨ Contributing
164137
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].
138+
This project is under active development, and we encourage contributions from our community.
139+
Many thanks to our outstanding contributors:
166140
167-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
141+
<a href="https://github.com/cloudposse/github-action-interface-environment/graphs/contributors">
142+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-interface-environment&max=24" />
143+
</a>
168144
169-
## DevOps Accelerator for Startups
145+
### 🐛 Bug Reports & Feature Requests
170146
147+
Please use the [issue tracker](https://github.com/cloudposse/github-action-interface-environment/issues) to report any bugs or file feature requests.
171148
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.
149+
### 💻 Developing
173150
174-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
151+
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].
175152
176-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
153+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
177154
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.
155+
1. **Fork** the repo on GitHub
156+
2. **Clone** the project to your own machine
157+
3. **Commit** changes to your own branch
158+
4. **Push** your work back up to your fork
159+
5. Submit a **Pull Request** so that we can review your changes
179160
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.
161+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
190162
191-
## Slack Community
163+
### 🌎 Slack Community
192164
193165
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.
194166
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
167+
### 📰 Newsletter
200168
201169
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.
202170
203-
## Office Hours
171+
### 📆 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" />
204172
205173
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
206174
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
212-
213-
Please use the [issue tracker](https://github.com/cloudposse/github-action-interface-environment/issues) to report any bugs or file feature requests.
175+
## About
214176
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!
177+
This project is maintained and funded by [Cloud Posse, LLC][website].
178+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
228179
180+
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.
229181
230-
## Copyright
182+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
231183
232-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
184+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
233185
186+
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.
234187
188+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
189+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
190+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
191+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
192+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
193+
- **Training.** You'll receive hands-on training so your team can operate what we build.
194+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
195+
- **Troubleshooting.** You'll get help to triage when things aren't working.
196+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
197+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
235198
199+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
236200
## License
237201
238202
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -258,42 +222,11 @@ specific language governing permissions and limitations
258222
under the License.
259223
```
260224

261-
262-
263-
264-
265-
266-
267-
268-
269225
## Trademarks
270226

271227
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-
228+
---
229+
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
297230
[![README Footer][readme_footer_img]][readme_footer_link]
298231
[![Beacon][beacon]][website]
299232
<!-- markdownlint-disable -->
@@ -304,12 +237,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
304237
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=jobs
305238
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=hire
306239
[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
308240
[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
310241
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=office_hours
311242
[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
313243
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=email
314244
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-interface-environment&utm_content=commercial_support
315245
[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 +250,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
320250
[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
321251
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
322252
[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
329253
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-interface-environment?pixel&cs=github&cm=readme&an=github-action-interface-environment
330254
<!-- 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)