Skip to content

Commit e6e4b81

Browse files
authored
Add readme alias (#45)
1 parent bde0a77 commit e6e4b81

File tree

4 files changed

+22
-10
lines changed

4 files changed

+22
-10
lines changed

.README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,17 @@ This automatically exposes many new targets that you can leverage throughout you
2222

2323
Run `make help` for a list of available targets.
2424

25+
**NOTE:** the `/` is interchangable with the `:` in target names
26+
2527
{{ (datasource "make").help }}
2628

2729
## Real World Examples
2830

29-
- [`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) - A Golang project that leverages `docker:%`, `go:%`, `travis:%` targets
30-
- [`charts`](https://github.com/cloudposse/charts/) - A collection of Helm Charts that leverages `docker:%` and `helm:%` targets
31-
- [`bastion`](https://github.com/cloudposse/bastion/) - A docker image that leverages `docker:%` and `bash:lint` targets
32-
- [`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) - A terraform module that leverages `terraform:%` targets
31+
- [`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) - A Golang project that leverages `docker/%`, `go/%`, `travis/%` targets
32+
- [`charts`](https://github.com/cloudposse/charts/) - A collection of Helm Charts that leverages `docker/%` and `helm/%` targets
33+
- [`bastion`](https://github.com/cloudposse/bastion/) - A docker image that leverages `docker/%` and `bash/lint` targets
34+
- [`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) - A terraform module that leverages `terraform/%` targets
35+
3336

3437
{{ (datasource "section").help }}
3538
{{ (datasource "section").contributing }}

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ This automatically exposes many new targets that you can leverage throughout you
2525

2626
Run `make help` for a list of available targets.
2727

28+
**NOTE:** the `/` is interchangable with the `:` in target names
29+
2830
## Makefile Targets
2931

3032
```bash
@@ -67,6 +69,7 @@ helm/serve/index Build index for serve helm charts
6769
help This help screen
6870
jenkins/run-job-with-tag Run a Jenkins Job with $(TAG)
6971
make/lint Lint all makefiles
72+
readme Alias for readme/build
7073
readme/build Create README.md by building it from .README.md file
7174
readme/init Create basic minimalistic .README.md template file
7275
readme/toc-update Update table of contents in README.md
@@ -82,10 +85,11 @@ travis/docker-tag-and-push Tag & Push according Travis environment vari
8285

8386
## Real World Examples
8487

85-
- [`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) - A Golang project that leverages `docker:%`, `go:%`, `travis:%` targets
86-
- [`charts`](https://github.com/cloudposse/charts/) - A collection of Helm Charts that leverages `docker:%` and `helm:%` targets
87-
- [`bastion`](https://github.com/cloudposse/bastion/) - A docker image that leverages `docker:%` and `bash:lint` targets
88-
- [`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) - A terraform module that leverages `terraform:%` targets
88+
- [`github-authorized-keys`](https://github.com/cloudposse/github-authorized-keys/) - A Golang project that leverages `docker/%`, `go/%`, `travis/%` targets
89+
- [`charts`](https://github.com/cloudposse/charts/) - A collection of Helm Charts that leverages `docker/%` and `helm/%` targets
90+
- [`bastion`](https://github.com/cloudposse/bastion/) - A docker image that leverages `docker/%` and `bash/lint` targets
91+
- [`terraform-null-label`](https://github.com/cloudposse/terraform-null-label/) - A terraform module that leverages `terraform/%` targets
92+
8993

9094
## Help
9195

modules/helm/Makefile.repo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,4 @@ helm/repo/clean:
107107

108108
## Build repo
109109
helm/repo/build: helm/repo/clean helm/repo/fix-perms helm/repo/deps helm/repo/lint helm/repo/package
110+
@exit 0

modules/readme/Makefile.docs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
README_FILE ?= README.md
2-
README_TEMPLATE_NAME ?= .$(README_FILE)
1+
export README_FILE ?= README.md
2+
export README_TEMPLATE_FILE ?= .$(README_FILE)
3+
4+
## Alias for readme/build
5+
readme: readme/build
6+
@exit 0
37

48
## Update table of contents in README.md
59
readme/toc-update:

0 commit comments

Comments
 (0)