great-docs ci pr-comment

Post or refresh a sticky PR comment with the local-preview command.

great-docs ci pr-comment [OPTIONS]

Reads the token from GITHUB_TOKEN / GH_TOKEN and needs pull-requests: write.

Full --help output

Usage: great-docs ci pr-comment [OPTIONS]

  Post or refresh a sticky PR comment with the local-preview command.

  Reads the token from GITHUB_TOKEN / GH_TOKEN and needs 'pull-requests:
  write'.

Options:
  --run INTEGER  Workflow run id that built the site.  [required]
  --pr INTEGER   Pull request number to comment on.  [required]
  --repo TEXT    GitHub repo as 'owner/repo' (default: $GITHUB_REPOSITORY,
                 then git remote).
  --help         Show this message and exit.

Options

--run: INTEGER

Required. Workflow run id that built the site.

--pr: INTEGER

Required. Pull request number to comment on.

--repo: TEXT

GitHub repo as owner/repo (default: $GITHUB_REPOSITORY, then git remote).