From 8313645760c76196c2263c2e9e291511b9e8ade4 Mon Sep 17 00:00:00 2001 From: "lynn [they]" Date: Wed, 18 Dec 2019 18:11:43 -0800 Subject: [PATCH 1/2] Update cli.yml --- .github/workflows/cli.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/cli.yml b/.github/workflows/cli.yml index 826762c..169d3f1 100644 --- a/.github/workflows/cli.yml +++ b/.github/workflows/cli.yml @@ -4,6 +4,7 @@ on: push: branches: - master + - v1 pull_request: branches: - master From 777b332bb7072b4d998798be0940dce165416beb Mon Sep 17 00:00:00 2001 From: Link Dupont Date: Wed, 18 Dec 2019 14:46:13 -0500 Subject: [PATCH 2/2] Use VisibleFlags during doc generation Hidden commands are excluded during doc generation but hidden flags are not. Using VisibleFlags() instead of the Flags slice fixes that. Signed-off-by: Link Dupont --- docs.go | 4 ++-- docs_test.go | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs.go b/docs.go index a8f5de9..dc16fc8 100644 --- a/docs.go +++ b/docs.go @@ -48,8 +48,8 @@ func (a *App) writeDocTemplate(w io.Writer) error { return t.ExecuteTemplate(w, name, &cliTemplate{ App: a, Commands: prepareCommands(a.Commands, 0), - GlobalArgs: prepareArgsWithValues(a.Flags), - SynopsisArgs: prepareArgsSynopsis(a.Flags), + GlobalArgs: prepareArgsWithValues(a.VisibleFlags()), + SynopsisArgs: prepareArgsSynopsis(a.VisibleFlags()), }) } diff --git a/docs_test.go b/docs_test.go index e52cf8b..e49dfba 100644 --- a/docs_test.go +++ b/docs_test.go @@ -22,6 +22,10 @@ func testApp() *App { Aliases: []string{"b"}, Usage: "another usage text", }, + &BoolFlag{ + Name: "hidden-flag", + Hidden: true, + }, } app.Commands = []*Command{{ Aliases: []string{"c"},