Skip to content

Commit

Permalink
Add readme alias (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman authored Feb 25, 2018
1 parent bde0a77 commit e6e4b81
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 10 deletions.
11 changes: 7 additions & 4 deletions .README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,17 @@ This automatically exposes many new targets that you can leverage throughout you

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

**NOTE:** the `/` is interchangable with the `:` in target names

{{ (datasource "make").help }}

## Real World Examples

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


{{ (datasource "section").help }}
{{ (datasource "section").contributing }}
Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ This automatically exposes many new targets that you can leverage throughout you

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

**NOTE:** the `/` is interchangable with the `:` in target names

## Makefile Targets

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

## Real World Examples

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


## Help

Expand Down
1 change: 1 addition & 0 deletions modules/helm/Makefile.repo
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,4 @@ helm/repo/clean:

## Build repo
helm/repo/build: helm/repo/clean helm/repo/fix-perms helm/repo/deps helm/repo/lint helm/repo/package
@exit 0
8 changes: 6 additions & 2 deletions modules/readme/Makefile.docs
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
README_FILE ?= README.md
README_TEMPLATE_NAME ?= .$(README_FILE)
export README_FILE ?= README.md
export README_TEMPLATE_FILE ?= .$(README_FILE)

## Alias for readme/build
readme: readme/build
@exit 0

## Update table of contents in README.md
readme/toc-update:
Expand Down

0 comments on commit e6e4b81

Please sign in to comment.