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

Change default make target and expand make help documentation #94

Merged
merged 3 commits into from
Nov 6, 2023

Conversation

andyasp
Copy link
Collaborator

@andyasp andyasp commented Nov 3, 2023

Builds off of the changes made in #86.

This changes the default goal (only running make) back to building the binary. It was changed to help before, but having to type make rollout-operator is a bit rough. I kept the help target at the top of the Makefile to keep the discoverability of the option since it is nice.

I also modified the awk command used in the help target to allow documenting the options with dependencies and then documented them. make help now prints:

Usage:
  make <target>

Targets:
  help                                           Display this help and any documented user-facing targets
  rollout-operator                               Build the rollout-operator binary
  rollout-operator-boringcrypto                  Build the rollout-operator binary with boringcrypto
  build-image                                    Build the rollout-operator image
  build-image-boringcrypto                       Build the rollout-operator image with boringcrypto
  publish-images                                 Build and publish both the standard and boringcrypto images
  publish-standard-image                         Build and publish only the standard rollout-operator image
  publish-boringcrypto-image                     Build and publish only the boring-crypto rollout-operator image
  test                                           Run tests
  test-boringcrypto                              Run tests with GOEXPERIMENT=boringcrypto
  integration                                    Run integration tests
  lint                                           Run golangci-lint
  clean                                          Run go clean and remove the rollout-operator binary

@andyasp andyasp added the documentation Improvements or additions to documentation label Nov 3, 2023
@andyasp andyasp marked this pull request as ready for review November 3, 2023 22:05
@andyasp andyasp requested a review from a team as a code owner November 3, 2023 22:05
@andyasp andyasp merged commit 401be1c into main Nov 6, 2023
6 checks passed
@andyasp andyasp deleted the aasp/make-help branch November 6, 2023 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants