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

Add help to makefile #1682

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

benjaminapetersen
Copy link

@benjaminapetersen benjaminapetersen commented Oct 31, 2024

The new Secrets Store Sync Controller has a nice output when make help (or bare make) is run. This PR just borrows the .PHONY: help incantation then reformats the headings and comments on [some] commands to match the regex in the @awk to print the following:

Screenshot 2024-10-31 at 12 16 20 PM

This is a quick pass to get some headings and commands and text printed. The specific output combo of headings/commands/text is up for conversation and feedback.

What type of PR is this?

I would consider this:

/kind documentation

What this PR does / why we need it:

See above comment and screenshot.

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #1681

Special notes for your reviewer:

Happy to take feedback on the specific items to print.

TODOs:

  • squashed commits
  • includes documentation
  • [ ] adds unit tests n/a

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 31, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: benjaminapetersen
Once this PR has been reviewed and has the lgtm label, please assign aramase for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Contributor

Hi @benjaminapetersen. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running make help (or bare make) should provide helpful commands to users
2 participants