workflows: Add setup-terraform before doc generation step (#248)

This commit is contained in:
Austin Valle 2024-10-01 12:48:37 -04:00 committed by GitHub
parent f8c917ff9c
commit a056b2fcbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 6 deletions

View File

@ -42,17 +42,15 @@ jobs:
with: with:
go-version-file: 'go.mod' go-version-file: 'go.mod'
cache: true cache: true
# Temporarily download Terraform 1.8 prerelease for function documentation support. # We need the latest version of Terraform for our documentation generation to use
# When Terraform 1.8.0 final is released, this can be removed.
- uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2 - uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
with: with:
terraform_version: '1.8.0-alpha20240216'
terraform_wrapper: false terraform_wrapper: false
- run: go generate ./... - run: make generate
- name: git diff - name: git diff
run: | run: |
git diff --compact-summary --exit-code || \ git diff --compact-summary --exit-code || \
(echo; echo "Unexpected difference in directories after code generation. Run 'go generate ./...' command and commit."; exit 1) (echo; echo "Unexpected difference in directories after code generation. Run 'make generate' command and commit."; exit 1)
# Run acceptance tests in a matrix with Terraform CLI versions # Run acceptance tests in a matrix with Terraform CLI versions
test: test:

View File

@ -53,7 +53,7 @@ If you wish to work on the provider, you'll first need [Go](http://www.golang.or
To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
To generate or update documentation, run `go generate`. To generate or update documentation, run `make generate`.
In order to run the full suite of Acceptance tests, run `make testacc`. In order to run the full suite of Acceptance tests, run `make testacc`.