tinkerbell / pbnj

Service for interacting with BMCs
Apache License 2.0
109 stars 37 forks source link

Add verbose make help #123

Closed micahhausler closed 2 years ago

micahhausler commented 2 years ago

Signed-off-by: Micah Hausler mhausler@amazon.com

Description

Enable verbose make help output and re-arrange some targets. This uses the help formatting from kubebuilder

Before

$ make help
buf-lint                       run linting
build                          compile the binary for the native OS
cover                          Run unit tests with coverage report
darwin                         complie for darwin
evans                          run evans grpc client
goimports-ci                   run goimports for ci
goimports                      run goimports
image                          make the Container Image
linux                          complie for linux
pbs-docker-image               generate container image for building protocol buffers 
pbs-docker                     generate go stubs from protocol buffers in a container
pbs-install-deps               locally install dependencies in order to generate go stubs from protocol buffers
pbs                            locally generate go stubs from protocol buffers
ruby-client-demo               run ruby client demo
run-image                      run PBnJ container image
run-server                     run server locally
test-ci                        run tests for ci and codecov
test-functional                run functional tests
test                           run tests

after

$ make help

Usage:
  make <target>
  help             Display this help.

Build
  darwin           complie for darwin
  linux            complie for linux
  build            compile the binary for the native OS
  image            make the Container Image

Development
  test             run tests
  test-ci          run tests for ci and codecov
  test-functional  run functional tests
  goimports-ci     run goimports for ci
  goimports        run goimports
  cover            Run unit tests with coverage report
  buf-lint         run linting
  run-server       run server locally
  pbs              locally generate go stubs from protocol buffers
  pbs-install-deps  locally install dependencies in order to generate go stubs from protocol buffers
  pbs-docker       generate go stubs from protocol buffers in a container
  pbs-docker-image  generate container image for building protocol buffers
  run-image        run PBnJ container image

Clients
  ruby-client-demo  run ruby client demo
  evans            run evans grpc client

Why is this needed

Working on #121, the kube-bulider generated make targets can be viewed in their own sections

How Has This Been Tested?

N/A

How are existing users impacted? What migration steps/scripts do we need?

No Change

Checklist:

I have: