From 8907e831f5f21bd2db515dee710e899ab79c4499 Mon Sep 17 00:00:00 2001 From: PePe Amengual <2208324+jamengual@users.noreply.github.com> Date: Fri, 15 Aug 2025 14:26:49 -0700 Subject: [PATCH] docs: replace version badges with comments in repo-level atlantis.yaml example (#5714) --- .../docs/repo-level-atlantis-yaml.md | 54 +++++++++---------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/runatlantis.io/docs/repo-level-atlantis-yaml.md b/runatlantis.io/docs/repo-level-atlantis-yaml.md index a3978c067..48cb5e8c3 100644 --- a/runatlantis.io/docs/repo-level-atlantis-yaml.md +++ b/runatlantis.io/docs/repo-level-atlantis-yaml.md @@ -53,40 +53,40 @@ manually configured project, the manually configured project will take precedenc ## Example Using All Keys ```yaml -version: 3 -automerge: true -autodiscover: +version: 3 # Available since v0.1.0 +automerge: true # Available since v0.15.0 +autodiscover: # Available since v0.18.0 mode: auto ignore_paths: - some/path -delete_source_branch_on_merge: true -parallel_plan: true -parallel_apply: true -abort_on_execution_order_fail: true +delete_source_branch_on_merge: true # Available since v0.15.0 +parallel_plan: true # Available since v0.17.0 +parallel_apply: true # Available since v0.17.0 +abort_on_execution_order_fail: true # Available since v0.17.0 projects: -- name: my-project-name - branch: /main/ - dir: . - workspace: default - terraform_distribution: terraform - terraform_version: v0.11.0 - delete_source_branch_on_merge: true - repo_locking: true # deprecated: use repo_locks instead - repo_locks: +- name: my-project-name # Available since v0.1.0 + branch: /main/ # Available since v0.20.0 + dir: . # Available since v0.1.0 + workspace: default # Available since v0.1.0 + terraform_distribution: terraform # Available since v0.25.0 + terraform_version: v0.11.0 # Available since v0.1.0 + delete_source_branch_on_merge: true # Available since v0.17.0 + repo_locking: true # deprecated: use repo_locks instead, Available since v0.17.0 + repo_locks: # Available since v0.17.0 mode: on_plan - custom_policy_check: false - autoplan: + custom_policy_check: false # Available since v0.17.0 + autoplan: # Available since v0.1.0 when_modified: ["*.tf", "../modules/**/*.tf", ".terraform.lock.hcl"] enabled: true - plan_requirements: [mergeable, approved, undiverged] - apply_requirements: [mergeable, approved, undiverged] - import_requirements: [mergeable, approved, undiverged] - silence_pr_comments: ["apply"] - execution_order_group: 1 - depends_on: + plan_requirements: [mergeable, approved, undiverged] # Available since v0.17.0 + apply_requirements: [mergeable, approved, undiverged] # Available since v0.17.0 + import_requirements: [mergeable, approved, undiverged] # Available since v0.17.0 + silence_pr_comments: ["apply"] # Available since v0.17.0 + execution_order_group: 1 # Available since v0.17.0 + depends_on: # Available since v0.20.0 - project-1 - workflow: myworkflow -workflows: + workflow: myworkflow # Available since v0.17.0 +workflows: # Available since v0.1.0 myworkflow: plan: steps: @@ -102,7 +102,7 @@ workflows: steps: - run: echo hi - apply -allowed_regexp_prefixes: +allowed_regexp_prefixes: # Available since v0.19.0 - dev/ - staging/ ```