Skip to content

Commit 3ef642c

Browse files
authored
Update README.md and docs
1 parent 46a8be6 commit 3ef642c

File tree

1 file changed

+47
-125
lines changed

1 file changed

+47
-125
lines changed

README.md

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

22
<!-- markdownlint-disable -->
3-
# github-action-docker-compose-test-run
3+
# github-action-docker-compose-test-run<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-docker-compose-test-run.svg)](https://github.com/cloudposse/github-action-docker-compose-test-run/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
Up docker compose and run tests in specific container
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 @@ Run tests in enviroment defined with Docker Compose
6448

6549

6650

67-
68-
6951
## Usage
7052

7153

@@ -120,15 +102,6 @@ Run tests in enviroment defined with Docker Compose
120102
<!-- markdownlint-restore -->
121103
122104
123-
124-
## Share the Love
125-
126-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-docker-compose-test-run)! (it helps us **a lot**)
127-
128-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
129-
130-
131-
132105
## Related Projects
133106
134107
Check out these related projects.
@@ -143,81 +116,70 @@ For additional context, refer to some of these links.
143116
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
144117
145118
146-
## Help
119+
## ✨ Contributing
147120
148-
**Got a question?** We got answers.
121+
This project is under active development, and we encourage contributions from our community.
122+
Many thanks to our outstanding contributors:
149123
150-
File a GitHub [issue](https://github.com/cloudposse/github-action-docker-compose-test-run/issues), send us an [email][email] or join our [Slack Community][slack].
124+
<a href="https://github.com/cloudposse/github-action-docker-compose-test-run/graphs/contributors">
125+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-docker-compose-test-run&max=24" />
126+
</a>
151127
152-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
128+
### 🐛 Bug Reports & Feature Requests
153129
154-
## DevOps Accelerator for Startups
130+
Please use the [issue tracker](https://github.com/cloudposse/github-action-docker-compose-test-run/issues) to report any bugs or file feature requests.
155131
132+
### 💻 Developing
156133
157-
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.
134+
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].
158135
159-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
160-
161-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
136+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
162137
163-
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.
138+
1. **Fork** the repo on GitHub
139+
2. **Clone** the project to your own machine
140+
3. **Commit** changes to your own branch
141+
4. **Push** your work back up to your fork
142+
5. Submit a **Pull Request** so that we can review your changes
164143
165-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
166-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
167-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
168-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
169-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
170-
- **Training.** You'll receive hands-on training so your team can operate what we build.
171-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
172-
- **Troubleshooting.** You'll get help to triage when things aren't working.
173-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
174-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
144+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
175145
176-
## Slack Community
146+
### 🌎 Slack Community
177147
178148
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.
179149
180-
## Discourse Forums
181-
182-
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.
183-
184-
## Newsletter
150+
### 📰 Newsletter
185151
186152
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.
187153
188-
## Office Hours
154+
### 📆 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" />
189155
190156
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
191157
192-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
158+
## About
193159
194-
## Contributing
195-
196-
### Bug Reports & Feature Requests
197-
198-
Please use the [issue tracker](https://github.com/cloudposse/github-action-docker-compose-test-run/issues) to report any bugs or file feature requests.
199-
200-
### Developing
201-
202-
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].
203-
204-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
205-
206-
1. **Fork** the repo on GitHub
207-
2. **Clone** the project to your own machine
208-
3. **Commit** changes to your own branch
209-
4. **Push** your work back up to your fork
210-
5. Submit a **Pull Request** so that we can review your changes
211-
212-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
160+
This project is maintained and funded by [Cloud Posse, LLC][website].
161+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
213162
163+
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.
214164
215-
## Copyright
165+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
216166
217-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
167+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
218168
169+
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.
219170
171+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
172+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
173+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
174+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
175+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
176+
- **Training.** You'll receive hands-on training so your team can operate what we build.
177+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
178+
- **Troubleshooting.** You'll get help to triage when things aren't working.
179+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
180+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
220181
182+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
221183
## License
222184
223185
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -243,42 +205,11 @@ specific language governing permissions and limitations
243205
under the License.
244206
```
245207

246-
247-
248-
249-
250-
251-
252-
253-
254208
## Trademarks
255209

256210
All other trademarks referenced herein are the property of their respective owners.
257-
258-
## About
259-
260-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
261-
262-
[![Cloud Posse][logo]][website]
263-
264-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
265-
266-
We offer [paid support][commercial_support] on all of our projects.
267-
268-
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.
269-
270-
271-
272-
### Contributors
273-
274-
<!-- markdownlint-disable -->
275-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
276-
|---|
277-
<!-- markdownlint-restore -->
278-
279-
[goruha_homepage]: https://github.com/goruha
280-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
281-
211+
---
212+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
282213
[![README Footer][readme_footer_img]][readme_footer_link]
283214
[![Beacon][beacon]][website]
284215
<!-- markdownlint-disable -->
@@ -289,12 +220,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
289220
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=jobs
290221
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=hire
291222
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=slack
292-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=linkedin
293223
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=twitter
294-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=testimonial
295224
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=office_hours
296225
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=newsletter
297-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=discourse
298226
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=email
299227
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=commercial_support
300228
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=we_love_open_source
@@ -305,11 +233,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
305233
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=readme_footer_link
306234
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
307235
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-compose-test-run&utm_content=readme_commercial_support_link
308-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-docker-compose-test-run&url=https://github.com/cloudposse/github-action-docker-compose-test-run
309-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-docker-compose-test-run&url=https://github.com/cloudposse/github-action-docker-compose-test-run
310-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-docker-compose-test-run
311-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-docker-compose-test-run
312-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-docker-compose-test-run
313-
[share_email]: mailto:?subject=github-action-docker-compose-test-run&body=https://github.com/cloudposse/github-action-docker-compose-test-run
314236
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-docker-compose-test-run?pixel&cs=github&cm=readme&an=github-action-docker-compose-test-run
315237
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)