Skip to content

Commit 784c6b3

Browse files
NuruNuru
authored
Do not clobber custom README *template* file (#380)
1 parent 420c75b commit 784c6b3

File tree

2 files changed

+56
-62
lines changed

2 files changed

+56
-62
lines changed

‎README.md‎

Lines changed: 51 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
21
<!-- markdownlint-disable -->
3-
[![Project Banner](.github/banner.png?raw=true)](https://cpco.io/homepage)
4-
[![Build Status](https://img.shields.io/github/actions/workflow/status/cloudposse/build-harness/docker.yml?style=for-the-badge)](https://github.com/cloudposse/build-harness/actions/workflows/docker.yml) [![Latest Release](https://img.shields.io/github/release/cloudposse/build-harness.svg?style=for-the-badge)](https://github.com/cloudposse/build-harness/releases/latest) [![Last Updated](https://img.shields.io/github/last-commit/cloudposse/build-harness/master?style=for-the-badge)](https://github.com/cloudposse/build-harness/commits/master/) [![Slack Community](https://slack.cloudposse.com/for-the-badge.svg)](https://slack.cloudposse.com)
2+
<a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/>
3+
<p align="right">
4+
<a href="https://github.com/cloudposse/build-harness/actions/workflows/docker.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/build-harness/docker.yml?style=for-the-badge" alt="Build Status"/></a><a href="https://github.com/cloudposse/build-harness/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/build-harness.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/build-harness/commits/master/"><img src="https://img.shields.io/github/last-commit/cloudposse/build-harness/master?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
55
<!-- markdownlint-restore -->
66

7-
87
<!--
98
109
1110
1211
1312
** DO NOT EDIT THIS FILE
1413
**
15-
** This file was automatically generated by the `build-harness`.
14+
** This file was automatically generated by the `cloudposse/build-harness`.
1615
** 1) Make all changes to `README.yaml`
1716
** 2) Run `make init` (you only need to do this once)
1817
** 3) Run`make readme` to rebuild this file.
@@ -31,18 +30,19 @@ It's designed to work with CI/CD systems such as GitHub Actions.
3130

3231
## Screenshots
3332

33+
<img src="docs/demo.gif?raw=true" alt="demo" />*Example of using the `build-harness` to build a docker image*
3434

35-
![demo](docs/demo.gif?raw=true)
36-
*Example of using the `build-harness` to build a docker image*
3735

3836
---
3937
> [!NOTE]
40-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
38+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=) approach towards DevOps.
39+
> <details><summary><strong>Learn More</strong></summary>
4140
>
4241
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
4342
>
43+
> </details>
4444
45-
[![README Header][readme_header_img]][readme_header_link]
45+
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
4646

4747

4848

@@ -323,7 +323,7 @@ For additional context, refer to some of these links.
323323

324324
## ✨ Contributing
325325

326-
This project is under active development, and we encourage contributions from our community.
326+
This project is under active development, and we encourage contributions from our community.
327327
Many thanks to our outstanding contributors:
328328

329329
<a href="https://github.com/cloudposse/build-harness/graphs/contributors">
@@ -336,45 +336,53 @@ Please use the [issue tracker](https://github.com/cloudposse/build-harness/issue
336336

337337
### 💻 Developing
338338

339-
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].
339+
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
340+
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=slack), in the `#cloudposse` channel.
340341

341342
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
342-
343-
1. **Fork** the repo on GitHub
344-
2. **Clone** the project to your own machine
345-
3. **Commit** changes to your own branch
346-
4. **Push** your work back up to your fork
347-
5. Submit a **Pull Request** so that we can review your changes
343+
1. Review our [Code of Conduct](https://github.com/cloudposse/build-harness/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
344+
2. **Fork** the repo on GitHub
345+
3. **Clone** the project to your own machine
346+
4. **Commit** changes to your own branch
347+
5. **Push** your work back up to your fork
348+
6. Submit a **Pull Request** so that we can review your changes
348349

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

351352
### 🌎 Slack Community
352353

353-
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.
354+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&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.
354355

355356
### 📰 Newsletter
356357

357-
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.
358+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&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.
359+
Dropped straight into your Inbox every week — and usually a 5-minute read.
358360

359-
### 📆 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" />
361+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&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>
360362

361-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
363+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&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.
364+
It's **FREE** for everyone!
362365

363-
## About
366+
## About
364367

365-
This project is maintained and funded by [Cloud Posse, LLC][website].
366-
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
368+
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=">Cloud Posse, LLC</a>.
369+
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
367370

368-
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.
371+
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=commercial_support) for funded startups and enterprises.
372+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
373+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
369374

370-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
375+
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
371376

372-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
377+
*Your team can operate like a pro today.*
373378

374-
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.
379+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
380+
381+
<details>
382+
<summary>📚 <strong>See What's Included</strong></summary>
375383

376384
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
377-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
385+
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
378386
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
379387
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
380388
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
@@ -383,14 +391,18 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
383391
- **Troubleshooting.** You'll get help to triage when things aren't working.
384392
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
385393
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
394+
</details>
386395

387-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
396+
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
388397
## License
389398

390-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
391-
392-
See [LICENSE](LICENSE) for full details.
399+
<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>
393400

401+
<details>
402+
<summary>Preamble to the Apache License, Version 2.0</summary>
403+
<br/>
404+
<br/>
405+
Complete license is available in the [`LICENSE`](LICENSE) file.
394406
```text
395407
Licensed to the Apache Software Foundation (ASF) under one
396408
or more contributor license agreements. See the NOTICE file
@@ -409,6 +421,7 @@ KIND, either express or implied. See the License for the
409421
specific language governing permissions and limitations
410422
under the License.
411423
```
424+
</details>
412425

413426
## Trademarks
414427

@@ -417,28 +430,8 @@ All other trademarks referenced herein are the property of their respective owne
417430

418431
Copyright © 2016-2024 [Cloud Posse, LLC](https://cloudposse.com)
419432

420-
[![README Footer][readme_footer_img]][readme_footer_link]
421-
[![Beacon][beacon]][website]
422-
<!-- markdownlint-disable -->
423-
[logo]: https://cloudposse.com/logo-300x69.svg
424-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=docs
425-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=website
426-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=github
427-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=jobs
428-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=hire
429-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=slack
430-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=twitter
431-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=office_hours
432-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=newsletter
433-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=email
434-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=commercial_support
435-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=we_love_open_source
436-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=terraform_modules
437-
[readme_header_img]: https://cloudposse.com/readme/header/img
438-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_header_link
439-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
440-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_footer_link
441-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
442-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_commercial_support_link
443-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/build-harness?pixel&cs=github&cm=readme&an=build-harness
444-
<!-- markdownlint-restore -->
433+
434+
435+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/build-harness&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
436+
437+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/build-harness?pixel&cs=github&cm=readme&an=build-harness"/>

‎modules/readme/Makefile‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ export README_TEMPLATE_REPO ?= .github
77
export README_TEMPLATE_REPO_REF ?= main
88
export README_TEMPLATE_REPO_PATH ?= README.md.gotmpl
99
export README_TEMPLATE_REPO_URL := https://raw.githubusercontent.com/$(README_TEMPLATE_REPO_ORG)/$(README_TEMPLATE_REPO)/$(README_TEMPLATE_REPO_REF)/$(README_TEMPLATE_REPO_PATH)
10-
export README_TEMPLATE_FILE ?= $(BUILD_HARNESS_PATH)/templates/README.md.gotmpl
10+
export README_TEMPLATE_REMOTE_FILE ?= $(BUILD_HARNESS_PATH)/templates/README.md.gotmpl
11+
export README_TEMPLATE_FILE ?= $(README_TEMPLATE_REMOTE_FILE)
1112
export README_TEMPLATE_YAML := $(BUILD_HARNESS_PATH)/templates/$(README_YAML)
1213

1314
# Only allow allowlisted orgs to supply the README template
@@ -22,11 +23,11 @@ export README_ALLOWLIST_ORGS := \
2223
cloudposse-terraform-components \
2324
terraform-aws-components
2425

25-
# Fetch the README.md.gotmpl every time, because we have no way of knowing if it's changed
26-
.PHONY: $(README_TEMPLATE_FILE)
26+
# Fetch the remote README.md.gotmpl every time, because we have no way of knowing if it's changed
27+
.PHONY: $(README_TEMPLATE_REMOTE_FILE)
2728

2829
# Fetch the README.md.gotmpl corresponding to this repo's GitHub Org
29-
$(README_TEMPLATE_FILE):
30+
$(README_TEMPLATE_REMOTE_FILE):
3031
@for README_GITHUB_ORG in $(README_ALLOWLIST_ORGS); do \
3132
if [ "$${README_GITHUB_ORG}" == "$${README_TEMPLATE_REPO_ORG}" ]; then \
3233
echo "Fetching README template from $${README_TEMPLATE_REPO_ORG}"; \

0 commit comments

Comments
 (0)