Skip to content

docs: policy check#6167

Merged
jamengual merged 1 commit intorunatlantis:mainfrom
albertorm95:docs-policy_check
Feb 8, 2026
Merged

docs: policy check#6167
jamengual merged 1 commit intorunatlantis:mainfrom
albertorm95:docs-policy_check

Conversation

@albertorm95
Copy link
Contributor

@albertorm95 albertorm95 commented Feb 8, 2026

Copilot AI review requested due to automatic review settings February 8, 2026 11:37
@dosubot dosubot bot added the docs Documentation label Feb 8, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the documentation to cover the policy_check internal command and how it interacts with --gh-team-allowlist, aiming to prevent manual atlantis plan runs from skipping policy checks when team allowlists are enabled.

Changes:

  • Documented policy_check as an available (internal) command and explained when it runs.
  • Added guidance/warnings in multiple docs pages about allowlisting policy_check when using --gh-team-allowlist.
  • Added example --gh-team-allowlist strings demonstrating required permissions.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
runatlantis.io/docs/server-configuration.md Adds policy_check to the command list and a tip block for --gh-team-allowlist users.
runatlantis.io/docs/repo-and-project-permissions.md Adds a warning about allowlisting policy_check to avoid skipping policy checks on manual plans.
runatlantis.io/docs/policy-checking.md Adds an “Important” warning explaining why policy_check must be allowlisted with team allowlists.

If you are using [policy checking](policy-checking.md), you must also allowlist the `policy_check` command:

```bash
--gh-team-allowlist="*:plan, *:policy_check, sre:apply"
Copy link

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This snippet differs from the other pages by omitting the atlantis server prefix, which can confuse readers into pasting it as a shell command rather than a flag on the atlantis server invocation. Consider making this example consistent by including atlantis server --gh-team-allowlist=... (or labeling it explicitly as “flag value only”).

Suggested change
--gh-team-allowlist="*:plan, *:policy_check, sre:apply"
atlantis server --gh-team-allowlist="*:plan, *:policy_check, sre:apply"

Copilot uses AI. Check for mistakes.
Signed-off-by: Alberto Rojas <albertorojasm95@gmail.com>
@jamengual jamengual changed the title docs policy check docs: policy check Feb 8, 2026
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 8, 2026
@jamengual jamengual merged commit 832abd0 into runatlantis:main Feb 8, 2026
33 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants