diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c91a5d9d..a8eb4652 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -39,6 +39,12 @@ jobs: run: task build - name: Format run: task lint + - name: Check if docs are up-to-date + run: | + task docs + git diff + BADDOCS=$(git status --porcelain) + test -z "$BADDOCS" || (echo -e "documentation needs regenerating using task docs: $BADDOCS"; exit 1) test: name: Matrix Test diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md index f2440ed4..9e3cf943 100644 --- a/docs/data-sources/project.md +++ b/docs/data-sources/project.md @@ -60,7 +60,7 @@ output "project_id" { ### Nested Schema for `password_protection` -Read-Only: +Optional: - `protect_production` (Boolean) If true, production deployments will also be protected diff --git a/docs/resources/dns_record.md b/docs/resources/dns_record.md index 7d6f0e5d..73e95412 100644 --- a/docs/resources/dns_record.md +++ b/docs/resources/dns_record.md @@ -124,7 +124,7 @@ For 'TXT' records, this can contain arbitrary text. ### Nested Schema for `srv` -Required: +Optional: - `port` (Number) The TCP or UDP port on which the service is to be found. - `priority` (Number) The priority of the target host, lower value means more preferred. diff --git a/docs/resources/project.md b/docs/resources/project.md index 6f2f60b4..dc654949 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -77,43 +77,31 @@ resource "vercel_project" "example" { ### Nested Schema for `environment` -Required: - -- `key` (String) The name of the Environment Variable. -- `target` (Set of String) The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`. -- `value` (String, Sensitive) The value of the Environment Variable. - Optional: - `git_branch` (String) The git branch of the Environment Variable. - -Read-Only: - - `id` (String) The ID of the Environment Variable. +- `key` (String) The name of the Environment Variable. +- `target` (Set of String) The environments that the Environment Variable should be present on. Valid targets are either `production`, `preview`, or `development`. +- `value` (String, Sensitive) The value of the Environment Variable. ### Nested Schema for `git_repository` -Required: - -- `repo` (String) The name of the git repository. For example: `vercel/next.js`. -- `type` (String) The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`. - Optional: - `production_branch` (String) By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here. +- `repo` (String) The name of the git repository. For example: `vercel/next.js`. +- `type` (String) The git provider of the repository. Must be either `github`, `gitlab`, or `bitbucket`. ### Nested Schema for `password_protection` -Required: - -- `password` (String, Sensitive) The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field. - Optional: +- `password` (String, Sensitive) The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field. - `protect_production` (Boolean) If true, production deployments will also be protected