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.

Sign up for GitHub

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

Jump to bottom

[Suggestion] Make help printing available operations #1867

Closed
wtrocki opened this issue Dec 1, 2020 · 2 comments · Fixed by #1947
Closed

[Suggestion] Make help printing available operations #1867

wtrocki opened this issue Dec 1, 2020 · 2 comments · Fixed by #1947
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@wtrocki
Copy link

wtrocki commented Dec 1, 2020

Generated makefile has a lot of commands for various tasks.
It will be amazing for the tool to self-document (as any edit in the file can be reflected in help as well). This pattern is being widely used in Makefiles

> make help

Welcome in the kubebuilder.
Available commands:

make build ... 
make install ...
@wtrocki wtrocki added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 1, 2020
@wtrocki
Copy link
Author

wtrocki commented Dec 1, 2020

Happy to contribute this change

@camilamacedo86 camilamacedo86 mentioned this issue Dec 15, 2020
Closed
5 tasks
@camilamacedo86 camilamacedo86 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Dec 15, 2020
@camilamacedo86
Copy link
Member

This was accepted in the bug triage meeting. As part of this one, we need to add at the end of the scaffold command output to make clear that users can check the help.

@camilamacedo86 camilamacedo86 mentioned this issue Jan 14, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

✨ Add help dialog to makefile template droctothorpe/kubebuilder
2 participants
@wtrocki @camilamacedo86