这是indexloc提供的服务，不要输入任何密码
Skip to content

call task docs in test workflow #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 19, 2023
Merged

call task docs in test workflow #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eed13f4
call task docs in test workflow
balazs4 Jun 19, 2023
3d3a7dd
add git diff --no-pager to make it clear what is the diff
balazs4 Jun 19, 2023
7c7f9a6
improve docs error message
balazs4 Jun 19, 2023
0733730
regenerate docs
balazs4 Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ output "project_id" {
<a id="nestedatt--password_protection"></a>
### Nested Schema for `password_protection`

Read-Only:
Optional:

- `protect_production` (Boolean) If true, production deployments will also be protected

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dns_record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ For 'TXT' records, this can contain arbitrary text.
<a id="nestedatt--srv"></a>
### 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.
Expand Down
24 changes: 6 additions & 18 deletions docs/resources/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,43 +77,31 @@ resource "vercel_project" "example" {
<a id="nestedatt--environment"></a>
### 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.


<a id="nestedatt--git_repository"></a>
### 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`.


<a id="nestedatt--password_protection"></a>
### 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


Expand Down