From 90fc4038137e3a9c0f4821e0b9aca711cb5eef22 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 19 Mar 2024 14:52:43 +0100 Subject: [PATCH] Document run watch and view not supporting fine grained PATs --- pkg/cmd/run/view/view.go | 8 +++++++- pkg/cmd/run/watch/watch.go | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go index d6cb008d0..c54905422 100644 --- a/pkg/cmd/run/view/view.go +++ b/pkg/cmd/run/view/view.go @@ -96,7 +96,13 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view []", Short: "View a summary of a workflow run", - Args: cobra.MaximumNArgs(1), + Long: heredoc.Docf(` + View a summary of a workflow run. + + This command does not support authenticating via fine grained PATs + as it is not currently possible to create a PAT with the %[1]schecks:read%[1]s permission. + `, "`"), + Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` # Interactively select a run to view, optionally selecting a single job $ gh run view diff --git a/pkg/cmd/run/watch/watch.go b/pkg/cmd/run/watch/watch.go index b4b51f20c..92120dc38 100644 --- a/pkg/cmd/run/watch/watch.go +++ b/pkg/cmd/run/watch/watch.go @@ -45,6 +45,12 @@ func NewCmdWatch(f *cmdutil.Factory, runF func(*WatchOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "watch ", Short: "Watch a run until it completes, showing its progress", + Long: heredoc.Docf(` + Watch a run until it completes, showing its progress. + + This command does not support authenticating via fine grained PATs + as it is not currently possible to create a PAT with the %[1]schecks:read%[1]s permission. + `, "`"), Example: heredoc.Doc(` # Watch a run until it's done gh run watch