Skip to content

Commit 3aa415a

Browse files
authored
Update README.md and docs
1 parent 7b0dada commit 3aa415a

File tree

1 file changed

+37
-162
lines changed

1 file changed

+37
-162
lines changed

README.md

Lines changed: 37 additions & 162 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# github-action-typescript-template [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-typescript-template.svg)](https://github.com/cloudposse/github-action-typescript-template/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4+
# github-action-typescript-template <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5+
<a href="https://github.com/cloudposse/github-action-typescript-template/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-typescript-template.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-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
108
<!--
119
1210
1311
1412
1513
** DO NOT EDIT THIS FILE
1614
**
17-
** This file was automatically generated by the `build-harness`.
15+
** This file was automatically generated by the `cloudposse/build-harness`.
1816
** 1) Make all changes to `README.yaml`
1917
** 2) Run `make init` (you only need to do this once)
2018
** 3) Run`make readme` to rebuild this file.
@@ -30,29 +28,6 @@
3028

3129
Template repo for GitHub Actions written in TypeScript
3230

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

5732

5833

@@ -63,11 +38,8 @@ This repo is a template for GitHub Actions written in TypeScript.
6338

6439

6540

66-
6741
## Usage
6842

69-
70-
7143
Use this repository as a template in your own GitHub Action project to get started.
7244

7345

@@ -78,15 +50,6 @@ Use this repository as a template in your own GitHub Action project to get start
7850

7951

8052

81-
82-
## Share the Love
83-
84-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-typescript-template)! (it helps us **a lot**)
85-
86-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
87-
88-
89-
9053
## Related Projects
9154

9255
Check out these related projects.
@@ -101,86 +64,55 @@ For additional context, refer to some of these links.
10164
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
10265

10366

104-
## Help
105-
106-
**Got a question?** We got answers.
107-
108-
File a GitHub [issue](https://github.com/cloudposse/github-action-typescript-template/issues), send us an [email][email] or join our [Slack Community][slack].
109-
110-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
111-
112-
## DevOps Accelerator for Startups
113-
114-
115-
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.
11667

117-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
11868

119-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
69+
## ✨ Contributing
12070

121-
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.
71+
This project is under active development, and we encourage contributions from our community.
12272

123-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
124-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
125-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
126-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
127-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
128-
- **Training.** You'll receive hands-on training so your team can operate what we build.
129-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
130-
- **Troubleshooting.** You'll get help to triage when things aren't working.
131-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
132-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
13373

134-
## Slack Community
13574

136-
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.
75+
Many thanks to our outstanding contributors:
13776

138-
## Discourse Forums
77+
<a href="https://github.com/cloudposse/github-action-typescript-template/graphs/contributors">
78+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-typescript-template&max=24" />
79+
</a>
13980

140-
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.
141-
142-
## Newsletter
143-
144-
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.
145-
146-
## Office Hours
147-
148-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
149-
150-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
151-
152-
## Contributing
153-
154-
### Bug Reports & Feature Requests
155-
156-
Please use the [issue tracker](https://github.com/cloudposse/github-action-typescript-template/issues) to report any bugs or file feature requests.
157-
158-
### Developing
159-
160-
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].
81+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-typescript-template/issues).
16182

16283
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
163-
164-
1. **Fork** the repo on GitHub
165-
2. **Clone** the project to your own machine
166-
3. **Commit** changes to your own branch
167-
4. **Push** your work back up to your fork
168-
5. Submit a **Pull Request** so that we can review your changes
84+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-typescript-template/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
85+
2. **Fork** the repo on GitHub
86+
3. **Clone** the project to your own machine
87+
4. **Commit** changes to your own branch
88+
5. **Push** your work back up to your fork
89+
6. Submit a **Pull Request** so that we can review your changes
16990

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

93+
### 🌎 Slack Community
17294

173-
## Copyright
95+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&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.
17496

175-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
97+
### 📰 Newsletter
17698

99+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&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.
100+
Dropped straight into your Inbox every week — and usually a 5-minute read.
177101

102+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&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>
178103

104+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&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.
105+
It's **FREE** for everyone!
179106
## License
180107

181-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
108+
<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>
109+
110+
<details>
111+
<summary>Preamble to the Apache License, Version 2.0</summary>
112+
<br/>
113+
<br/>
182114

183-
See [LICENSE](LICENSE) for full details.
115+
Complete license is available in the [`LICENSE`](LICENSE) file.
184116

185117
```text
186118
Licensed to the Apache Software Foundation (ASF) under one
@@ -200,74 +132,17 @@ KIND, either express or implied. See the License for the
200132
specific language governing permissions and limitations
201133
under the License.
202134
```
203-
204-
205-
206-
207-
208-
209-
210-
135+
</details>
211136

212137
## Trademarks
213138

214139
All other trademarks referenced herein are the property of their respective owners.
215140

216-
## About
217-
218-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
219-
220-
[![Cloud Posse][logo]][website]
221-
222-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
223-
224-
We offer [paid support][commercial_support] on all of our projects.
225141

226-
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.
227-
228-
229-
230-
### Contributors
142+
---
143+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
231144

232-
<!-- markdownlint-disable -->
233-
| [![Matt Calhoun][mcalhoun_avatar]][mcalhoun_homepage]<br/>[Matt Calhoun][mcalhoun_homepage] |
234-
|---|
235-
<!-- markdownlint-restore -->
236145

237-
[mcalhoun_homepage]: https://github.com/mcalhoun
238-
[mcalhoun_avatar]: https://img.cloudposse.com/150x150/https://github.com/mcalhoun.png
146+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
239147

240-
[![README Footer][readme_footer_img]][readme_footer_link]
241-
[![Beacon][beacon]][website]
242-
<!-- markdownlint-disable -->
243-
[logo]: https://cloudposse.com/logo-300x69.svg
244-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=docs
245-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=website
246-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=github
247-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=jobs
248-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=hire
249-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=slack
250-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=linkedin
251-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=twitter
252-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=testimonial
253-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=office_hours
254-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=newsletter
255-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=discourse
256-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=email
257-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=commercial_support
258-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=we_love_open_source
259-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=terraform_modules
260-
[readme_header_img]: https://cloudposse.com/readme/header/img
261-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=readme_header_link
262-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
263-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=readme_footer_link
264-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
265-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-typescript-template&utm_content=readme_commercial_support_link
266-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-typescript-template&url=https://github.com/cloudposse/github-action-typescript-template
267-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-typescript-template&url=https://github.com/cloudposse/github-action-typescript-template
268-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-typescript-template
269-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-typescript-template
270-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-typescript-template
271-
[share_email]: mailto:?subject=github-action-typescript-template&body=https://github.com/cloudposse/github-action-typescript-template
272-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-typescript-template?pixel&cs=github&cm=readme&an=github-action-typescript-template
273-
<!-- markdownlint-restore -->
148+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-typescript-template?pixel&cs=github&cm=readme&an=github-action-typescript-template"/>

0 commit comments

Comments
 (0)