Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Makefile Help #1638

Merged
merged 1 commit into from
Aug 12, 2020
Merged

Makefile Help #1638

merged 1 commit into from
Aug 12, 2020

Conversation

kensipe
Copy link
Member

@kensipe kensipe commented Aug 6, 2020

Signed-off-by: Ken Sipe kensipe@gmail.com

Stumbled across an example of this and loved it. Adds help to make which required rearrangement to achieved desired output. Here is an example:

❯ make help
Usage: make <OPTIONS> ... <TARGETS>

Available targets are:


Usage:
  make <target>
  help             Show this help screen

Tests
  test             Runs unit tests
  integration-test Runs integration tests
  test-clean       cleans test outputs

Development
  all              Build manager and runs unit tests
  lint             Run golangci-lint
  manager          Builds manager
  manager-fast     Builds manager without code generation
  run              Runs Manager locally (requires ngrok or webhook management)
  cli              Builds CLI with code generation
  cli-install      Installs kubectl-kudo to GOBIN
  clean            Cleans cli, tests and manager
  docker-build     Docker Build (for dev only)
  dev-ready        Installs KUDO manifests and updates webhook to work with ngrok

Generate
  generate         (Re)Generates CRDs and go-bindata
  update-golden    Updates golden files

except in color :)

Signed-off-by: Ken Sipe <kensipe@gmail.com>
Copy link
Member

@ANeumann82 ANeumann82 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I like it

@kensipe kensipe merged commit 3be4d12 into main Aug 12, 2020
@kensipe kensipe deleted the ken/make-help branch August 12, 2020 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants