Skip to content

Commit 6f29173

Browse files
authored
Update README.md and docs
1 parent 9088fd0 commit 6f29173

File tree

1 file changed

+49
-129
lines changed

1 file changed

+49
-129
lines changed

README.md

Lines changed: 49 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11

22
<!-- markdownlint-disable -->
3-
# github-action-secret-outputs [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-secret-outputs.svg)](https://github.com/cloudposse/github-action-secret-outputs/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
# github-action-secret-outputs<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-secret-outputs.svg)](https://github.com/cloudposse/github-action-secret-outputs/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
96

107
<!--
118
@@ -34,32 +31,15 @@ The problem was described in
3431
[`GitHub Action documentation`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs)
3532
- `Outputs containing secrets are redacted on the runner and not sent to GitHub Actions`.
3633

37-
---
38-
39-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
40-
[<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]
41-
[<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]
42-
[<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]
43-
[<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]
44-
[<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]
45-
[<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]
46-
47-
48-
49-
50-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
51-
52-
53-
54-
55-
56-
57-
58-
59-
60-
6134

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

6444

6545

@@ -138,15 +118,6 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
138118
<!-- markdownlint-restore -->
139119
140120
141-
142-
## Share the Love
143-
144-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-secret-outputs)! (it helps us **a lot**)
145-
146-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
147-
148-
149-
150121
## Related Projects
151122
152123
Check out these related projects.
@@ -164,84 +135,73 @@ For additional context, refer to some of these links.
164135
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs) - Outputs containing secrets are redacted on the runner and not sent to GitHub Actions
165136
166137
167-
## Help
138+
## ✨ Contributing
168139
169-
**Got a question?** We got answers.
140+
This project is under active development, and we encourage contributions from our community.
141+
Many thanks to our outstanding contributors:
170142
171-
File a GitHub [issue](https://github.com/cloudposse/github-action-secret-outputs/issues), send us an [email][email] or join our [Slack Community][slack].
143+
<a href="https://github.com/cloudposse/github-action-secret-outputs/graphs/contributors">
144+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-secret-outputs&max=24" />
145+
</a>
172146
173-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
174-
175-
## DevOps Accelerator for Startups
147+
### 🐛 Bug Reports & Feature Requests
176148
149+
Please use the [issue tracker](https://github.com/cloudposse/github-action-secret-outputs/issues) to report any bugs or file feature requests.
177150
178-
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.
151+
### 💻 Developing
179152
180-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
153+
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].
181154
182-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
155+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
183156
184-
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.
157+
1. **Fork** the repo on GitHub
158+
2. **Clone** the project to your own machine
159+
3. **Commit** changes to your own branch
160+
4. **Push** your work back up to your fork
161+
5. Submit a **Pull Request** so that we can review your changes
185162
186-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
187-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
188-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
189-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
190-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
191-
- **Training.** You'll receive hands-on training so your team can operate what we build.
192-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
193-
- **Troubleshooting.** You'll get help to triage when things aren't working.
194-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
195-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
163+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
196164
197-
## Slack Community
165+
### 🌎 Slack Community
198166
199167
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.
200168
201-
## Discourse Forums
202-
203-
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.
204-
205-
## Newsletter
169+
### 📰 Newsletter
206170
207171
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.
208172
209-
## Office Hours
173+
### 📆 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" />
210174
211175
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
212176
213-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
214-
215-
## Contributing
177+
## About
216178
217-
### Bug Reports & Feature Requests
218-
219-
Please use the [issue tracker](https://github.com/cloudposse/github-action-secret-outputs/issues) to report any bugs or file feature requests.
220-
221-
### Developing
222-
223-
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].
224-
225-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
226-
227-
1. **Fork** the repo on GitHub
228-
2. **Clone** the project to your own machine
229-
3. **Commit** changes to your own branch
230-
4. **Push** your work back up to your fork
231-
5. Submit a **Pull Request** so that we can review your changes
232-
233-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
179+
This project is maintained and funded by [Cloud Posse, LLC][website].
180+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
234181
182+
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.
235183
236-
## Copyright
184+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
237185
238-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
186+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
239187
188+
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.
240189
190+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
191+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
192+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
193+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
194+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
195+
- **Training.** You'll receive hands-on training so your team can operate what we build.
196+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
197+
- **Troubleshooting.** You'll get help to triage when things aren't working.
198+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
199+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
241200
201+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
242202
## License
243203
244-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
204+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
245205
246206
See [LICENSE](LICENSE) for full details.
247207
@@ -264,42 +224,11 @@ specific language governing permissions and limitations
264224
under the License.
265225
```
266226

267-
268-
269-
270-
271-
272-
273-
274-
275227
## Trademarks
276228

277229
All other trademarks referenced herein are the property of their respective owners.
278-
279-
## About
280-
281-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
282-
283-
[![Cloud Posse][logo]][website]
284-
285-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
286-
287-
We offer [paid support][commercial_support] on all of our projects.
288-
289-
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.
290-
291-
292-
293-
### Contributors
294-
295-
<!-- markdownlint-disable -->
296-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
297-
|---|
298-
<!-- markdownlint-restore -->
299-
300-
[goruha_homepage]: https://github.com/goruha
301-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
302-
230+
---
231+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
303232
[![README Footer][readme_footer_img]][readme_footer_link]
304233
[![Beacon][beacon]][website]
305234
<!-- markdownlint-disable -->
@@ -310,12 +239,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
310239
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=jobs
311240
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=hire
312241
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=slack
313-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=linkedin
314242
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=twitter
315-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=testimonial
316243
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=office_hours
317244
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=newsletter
318-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=discourse
319245
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=email
320246
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=commercial_support
321247
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=we_love_open_source
@@ -326,11 +252,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
326252
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=readme_footer_link
327253
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
328254
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-secret-outputs&utm_content=readme_commercial_support_link
329-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-secret-outputs&url=https://github.com/cloudposse/github-action-secret-outputs
330-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-secret-outputs&url=https://github.com/cloudposse/github-action-secret-outputs
331-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-secret-outputs
332-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-secret-outputs
333-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-secret-outputs
334-
[share_email]: mailto:?subject=github-action-secret-outputs&body=https://github.com/cloudposse/github-action-secret-outputs
335255
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-secret-outputs?pixel&cs=github&cm=readme&an=github-action-secret-outputs
336256
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)