Skip to content

meta(make): Add help messages to Makefile#1414

Closed
olksdr wants to merge 5 commits intogetsentry:masterfrom
olksdr:feat/add-help-into-make
Closed

meta(make): Add help messages to Makefile#1414
olksdr wants to merge 5 commits intogetsentry:masterfrom
olksdr:feat/add-help-into-make

Conversation

@olksdr
Copy link
Copy Markdown
Contributor

@olksdr olksdr commented Aug 15, 2022

Adding useful documentation or help messages to the Makefile will help
contributors to quickly check all the available targets and what exactly
they do without opening the file itself.

Now one can just run make help to get the beautiful help message, like :

❯ make help
Usage: make <target>
Targets:
  all                   run all checks and tests
  check                 run the lints and check the code style for rust and python code
  clean                 remove python virtual environment and delete cached rust files together with .target folder
  build                 build relay with all features enabled with debug info
  release               build production release of the relay with

...

#skip-changelog

@olksdr
docs(make): Add help messages to Makefile
a2382ce 
Adding useful documentation or help messages to the Makefile will help
contributers to quickly check all the available targets and what exactly
they do without opening the file itself.
@olksdr olksdr requested a review from a team August 15, 2022 06:33
@olksdr olksdr self-assigned this Aug 15, 2022
@olksdr olksdr mentioned this pull request Aug 15, 2022
Merged
@jan-auer jan-auer changed the title docs(make): Add help messages to Makefile meta(make): Add help messages to Makefile Aug 16, 2022
jan-auer
jan-auer approved these changes Aug 16, 2022
View reviewed changes
@olksdr @jan-auer
meta(make): Clarify help messages
549a858 
Co-authored-by: Jan Michael Auer <account@jauer.org>
iker-barriocanal
iker-barriocanal approved these changes Aug 16, 2022
View reviewed changes
olksdr and others added 3 commits August 16, 2022 10:43
@olksdr @iker-barriocanal
meta(make): clarify message about venv setup
ab11c31 
Co-authored-by: Iker Barriocanal <32816711+iker-barriocanal@users.noreply.github.com>
@olksdr
Trigger build
e07eca9
@olksdr
Make sure all the tests and integrations pass
08f185a
@olksdr
Copy link
Copy Markdown
Contributor Author

olksdr commented Aug 16, 2022

closing in favour of #1419

@olksdr olksdr closed this Aug 16, 2022
@olksdr olksdr deleted the feat/add-help-into-make branch August 16, 2022 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jan-auer jan-auer jan-auer approved these changes

+1 more reviewer

@iker-barriocanal iker-barriocanal iker-barriocanal approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@olksdr olksdr

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@olksdr @jan-auer @iker-barriocanal