diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml new file mode 100644 index 00000000..c9455175 --- /dev/null +++ b/.github/linters/.markdown-lint.yml @@ -0,0 +1,35 @@ +--- +########################### +########################### +## Markdown Linter rules ## +########################### +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint +# +# Note: +# To comment out a single error: +# +# any violations you want +# +# + +############### +# Rules by id # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: null +MD026: + punctuation: ".,;:!。,;:" # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines + diff --git a/.github/linters/.markdown-lint.yml.swp b/.github/linters/.markdown-lint.yml.swp new file mode 100644 index 00000000..c7cdc42a Binary files /dev/null and b/.github/linters/.markdown-lint.yml.swp differ diff --git a/.github/workflows/linter.yaml b/.github/workflows/linter.yaml index f8c351e2..03006e1c 100644 --- a/.github/workflows/linter.yaml +++ b/.github/workflows/linter.yaml @@ -17,5 +17,6 @@ jobs: env: VALIDATE_ALL_CODEBASE: false VALIDATE_YAML: false + VALIDATE_KUBERNETES_KUBEVAL: false DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/charts/atlantis/Chart.yaml b/charts/atlantis/Chart.yaml index fdf6729b..97552c5c 100644 --- a/charts/atlantis/Chart.yaml +++ b/charts/atlantis/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: v0.14.0 description: A Helm chart for Atlantis https://www.runatlantis.io name: atlantis -version: 3.12.4 +version: 3.12.5 keywords: - terraform home: https://www.runatlantis.io diff --git a/charts/atlantis/README.md b/charts/atlantis/README.md index 9fc23095..5417c62d 100644 --- a/charts/atlantis/README.md +++ b/charts/atlantis/README.md @@ -6,22 +6,22 @@ This chart creates a single pod in a StatefulSet running Atlantis. Atlantis persists Terraform [plan files](https://www.terraform.io/docs/commands/plan.html) and [lock files](https://www.terraform.io/docs/state/locking.html) to disk for the duration of a Pull/Merge Request. These files are stored in a PersistentVolumeClaim to survive Pod failures. ## Prerequisites -- Kubernetes 1.9+ -- PersistentVolume support +- Kubernetes 1.9+ +- PersistentVolume support ## Required Configuration In order for Atlantis to start and run successfully: 1. At least one of the following sets of credentials must be defined: - - `github` - - `gitlab` - - `bitbucket` + - `github` + - `gitlab` + - `bitbucket` Refer to [values.yaml](values.yaml) for detailed examples. They can also be provided directly through a Kubernetes `Secret`, use the variable `vcsSecretName` to reference it. 1. Supply a value for `orgWhitelist`, e.g. `github.org/myorg/*`. -## Additional manifests +## Additional manifests It is possible to add additional manifests into a deployment, to extend the chart. One of the reason is to deploy a manifest specific to a cloud provider ( BackendConfig on GKE for example ). @@ -102,7 +102,7 @@ The following options are supported. See [values.yaml](values.yaml) for more de ## Upgrading -### From 2.* to 3.* +### From `2.*` to `3.*` * The following value names have been removed. They are replaced by [Server Side Repo Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) * `requireApproval` * `requireMergeable` @@ -110,7 +110,7 @@ The following options are supported. See [values.yaml](values.yaml) for more de To replicate your previous configuration, run Atlantis locally with your previous flags and Atlantis will print out the equivalent repo-config, for example: -``` +```bash $ atlantis server --allow-repo-config --require-approval --require-mergeable --gh-user=foo --gh-token=bar --repo-whitelist='*' WARNING: Flags --require-approval, --require-mergeable and --allow-repo-config have been deprecated. Create a --repo-config file with the following config instead: @@ -127,7 +127,7 @@ or use --repo-config-json='{"repos":[{"id":"/.*/", "apply_requirements":["approv Then use this YAML in the new repoConfig value: -``` +```yaml repoConfig: | --- repos: @@ -137,7 +137,7 @@ repoConfig: | allow_custom_workflows: true ``` -### From 1.* to 2.* +### From `1.*` to `2.*` * The following value names have changed: * `allow_repo_config` => `allowRepoConfig` * `atlantis_data_storage` => `dataStorage` **NOTE: more than just a snake_case change**