Skip to content

Feature(Fixes #7229) : Refine the Makefile file so that it can do the basic work#7228

Merged
samcoe merged 0 commit intocli:trunkfrom
cubxxw:trunk
Mar 27, 2023
Merged

Feature(Fixes #7229) : Refine the Makefile file so that it can do the basic work#7228
samcoe merged 0 commit intocli:trunkfrom
cubxxw:trunk

Conversation

@cubxxw
Copy link

@cubxxw cubxxw commented Mar 25, 2023

Refine the Makefile file so that it can do the basic work
There is no help information in the CLI makefile, which is not developer-friendly, and I wish I could add help for a better experience.

Fixes #7229

The effect is as follows:

❯ make help

Usage:

  make [target]

Targets:

  bin/gh      Build gh binary
  clean       Clean the build directory
  manpages    Build manpages
  test        Run go tests
  site        Clone the gh-pages branch
  site-docs   Build and publish help docs to GitHub Pages
  site-bump   Update website with latest version of gh
  install     Install gh
  uninstall   Uninstall gh
  help        Display help information

@cubxxw cubxxw requested a review from a team as a code owner March 25, 2023 13:27
@cubxxw cubxxw requested review from vilmibm and removed request for a team March 25, 2023 13:27
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Mar 25, 2023
@cliAutomation
Copy link
Collaborator

Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

@cubxxw cubxxw changed the title Feature(makefile) : Refine the Makefile file so that it can do the basic work Feature(Fixes #7229) : Refine the Makefile file so that it can do the basic work Mar 25, 2023
@samcoe samcoe requested a review from mislav March 26, 2023 21:45
@samcoe samcoe removed the request for review from vilmibm March 26, 2023 21:46
@cubxxw
Copy link
Author

cubxxw commented Mar 27, 2023

@samcoe oh, excuse my lack of insight, I wonder why my PR commit message is missing, it surprises me.

@cubxxw
Copy link
Author

cubxxw commented Mar 27, 2023

The makefile function is too simple. As the first step of my contribution to cli, I should make more people happy to use the makefile. In the first stage of contribution, I want to continue to enrich the makefile, don't you think?

@samcoe samcoe merged commit 185ebbe into cli:trunk Mar 27, 2023
@mislav
Copy link
Contributor

mislav commented Mar 27, 2023

Hi, I'm trying to untangle what happened here, but I think you opened a PR from the trunk branch in your fork, but then the “Pull” bot had reset your trunk branch and thus effectively erased the contents of this PR. Afterwards, GitHub erroneously thought that this PR was merged and marked it as such. However, none of your changes got merged.

Nevertheless, I have reviewed your originally proposed changes at cubxxw@f9dad36 and even though I can see how a better-documented Makefile is nice to have, the solution is somewhat hacky and I don't think we want to maintain it, especially since the "standard" make commands (make, make test, make install, make clean) should be self-evident, and all the other ones should only be used by our team and not by outside contributors.

For your future PRs, please disable the Pull bot on your account resetting branches that you have opened PRs from.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external pull request originating outside of the CLI core team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Add help information to the makefile

4 participants