-
Notifications
You must be signed in to change notification settings - Fork 671
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
Adds help command #1622
Adds help command #1622
Conversation
Thank you for creating this PR! @kumare3 / @EngHabu / @evalsocket, can you let me know if any other changes need to be made in the Makefiles or configuration files? If there are any, and if @hasukmistry is willing to take up those, I can approve this PR for Hacktoberfest. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contributions. Left just a couple of suggestions and comments..
Makefile
Outdated
.PHONY: end2end | ||
end2end: | ||
end2end: ## Launch dockernetes and execute tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this is deprecated... Can you check if it's used throughout the repo. And if not, please delete the target.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like this script end2end/launch_dockernetes.sh
is still in place. I am not sure about it. I can remove target if you want me to :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The file exists, but I don't think end2end/launch_dockernetes.sh
is being used anywhere else.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samhita-alla so can i remove the target?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@evalsocket this target isn't surely required, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it's deprecated.
|
||
.PHONY: help | ||
help: SHELL := /bin/sh | ||
help: ## List available commands and their usage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work on vanilla OSX and Linux with no additional tools?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have tested this with Ubuntu, Mac Os without installing any additional tool.
Introduces help command in makefile. Adds comments along with make targets to display in make help section. Signed-off-by: Hasmukh K Mistry <[email protected]>
Makes changes based on suggestions Signed-off-by: Hasmukh K Mistry <[email protected]>
91626e1
to
533cc08
Compare
Removes unused target from makefile Signed-off-by: Hasmukh K Mistry <[email protected]>
8d82ce0
to
f16b43e
Compare
can we merge this PR? |
Congrats on merging your first pull request! 🎉 |
Introduces help command in makefile. Adds comments along with make targets to display in make help section.