Skip to content

Commit ddd3568

Browse files
committed
feat: Automatically remove the README instructions
Many times when people use this template they forget to remove the template overview from the README for quite a while. This should speed up the process.
1 parent 422f695 commit ddd3568

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/workflows/scripts/rename_project.sh

+2
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,6 @@ done
2929

3030
# This command runs only once on GitHub Actions!
3131
rm -f .github/workflows/rename_template.yml
32+
rm -f .github/scorecard.yml
33+
sed -i '1,/^---$/d;/^$/d' README.md
3234
rm -rf .github/workflows/scripts

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/template-repository)
1+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginx/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginx/template-repository)
22
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
3-
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/template-repository/blob/main/SUPPORT.md)
3+
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md)
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
5+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
66

77
# NGINX Template Repository
88

@@ -33,23 +33,22 @@ This template includes all the scaffolding you need to get started on an OSS rep
3333

3434
## How do I use this template?
3535

36-
**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginxinc/template-repository/generate)** feature.
36+
**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginx/template-repository/generate)** feature.
3737

38-
1. Click on **[`Use this template`](https://github.com/nginxinc/template-repository/generate)**.
38+
1. Click on **[`Use this template`](https://github.com/nginx/template-repository/generate)**.
3939
2. Give a name to your project.
4040
3. Wait until the first run of CI finishes (GitHub Actions will process the template and commit to your new repo).
41-
4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README!
41+
4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README! This README section will self-destruct.
4242
5. Happy coding!
4343

4444
**NOTE**: **WAIT** until the first CI run on GitHub Actions finishes before cloning your new project.
4545

4646
---
4747

48-
<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
49-
5048
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
5149
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}})
5250
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md) <!-- [![Commercial Support](https://badgen.net/badge/support/commercial/cyan?icon=awesome)](<Insert URL>) -->
51+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5352
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
5453

5554
# {{REPOSITORY_NAME}}

0 commit comments

Comments
 (0)