Skip to content

Feature: Add help information to the makefile #7229

@cubxxw

Description

@cubxxw

Describe the feature or problem you’d like to solve

Makefiles are not friendly to newbies and want to add help information to help new developers. So I suggested adding help information to the makefile

Proposed solution

Use the ## matching option in the makefile and add help

Additional context

❯ 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions