Skip to content

Commit

Permalink
Merge pull request cli#8843 from cli/wm/doc-run-view-and-watch
Browse files Browse the repository at this point in the history
Document run watch and view not supporting fine grained PATs
  • Loading branch information
williammartin authored Mar 19, 2024
2 parents b85083c + 90fc403 commit 83f0b5b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pkg/cmd/run/view/view.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,13 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
cmd := &cobra.Command{
Use: "view [<run-id>]",
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
Expand Down
6 changes: 6 additions & 0 deletions pkg/cmd/run/watch/watch.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ func NewCmdWatch(f *cmdutil.Factory, runF func(*WatchOptions) error) *cobra.Comm
cmd := &cobra.Command{
Use: "watch <run-id>",
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
Expand Down

0 comments on commit 83f0b5b

Please sign in to comment.