# great-docs ci


Helpers meant to run inside CI (GitHub Actions).


``` bash
great-docs ci COMMAND [ARGS]...
```


These emit the "preview this build locally" hints that let reviewers open a pull request's docs without a preview host: a workflow log notice and a sticky PR comment, both pointing at `great-docs preview`.


<span class="gd-details-chevron" aria-hidden="true"></span>Full --help output


    Usage: great-docs ci [OPTIONS] COMMAND [ARGS]...

      Helpers meant to run inside CI (GitHub Actions).

      These emit the "preview this build locally" hints that let reviewers open a
      pull request's docs without a preview host: a workflow log notice and a
      sticky PR comment, both pointing at 'great-docs preview'.

      Examples:
        great-docs ci notice --run "$GITHUB_RUN_ID" --pr 302
        great-docs ci pr-comment --run "$GITHUB_RUN_ID" --pr 302

    Options:
      --help  Show this message and exit.

    Commands:
      pr-comment  Post or refresh a sticky PR comment with the local-preview...
      notice      Print a workflow log notice with the local-preview command.


# Commands


`pr-comment`  
[Post or refresh a sticky PR comment with the local-preview command.](../../reference/cli/ci/pr_comment.md)

`notice`  
[Print a workflow log notice with the local-preview command.](../../reference/cli/ci/notice.md)


# Examples

``` bash
  great-docs ci notice --run "$GITHUB_RUN_ID" --pr 302
  great-docs ci pr-comment --run "$GITHUB_RUN_ID" --pr 302
```