STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #8843 from cli/wm/doc-run-view-and-watch

Browse source 
Document run watch and view not supporting fine grained PATs
This commit is contained in:
William Martin 2024-03-19 15:03:04 +01:00 • committed by GitHub
commit 83f0b5b810
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
pkg/cmd/run/view/view.go
View file

@ -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

6
pkg/cmd/run/watch/watch.go
View file

@ -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