Skip to content

Commit

Permalink
Add documentation CI job
Browse files Browse the repository at this point in the history
To ensure that 'make docs' functionality does not break.
  • Loading branch information
stuart-mclaren-hpe committed Sep 4, 2024
1 parent d633174 commit 3f16737
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 8 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright 2024 Hewlett Packard Enterprise Development LP
name: Build

on:
push:
branches:
- main
pull_request:
jobs:
docs:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: '1.22.3'
- uses: hashicorp/setup-terraform@v2
with:
terraform_version: 1.9.5
- run: make install-experimental
- run: go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@v0.19.4
- run: make docs
21 changes: 13 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,16 @@ install-experimental:
go install -tags experimental ./...

docs:
echo -e ${PROVIDER_TF} > __docs.tf; \
tempfile=$$(mktemp); \
terraform providers schema -json | \
sed 's@github.com/hewlettpackard/hpegl-pcbe-terraform-resources@hpegl@g' > $$tempfile; \
tfplugindocs generate --providers-schema $$tempfile -provider-name hpegl;
printf "${PROVIDER_TF}" > __docs.tf; \
cat __docs.tf; \
tfconfig=$$(mktemp); \
sed "s@__HOME__@${HOME}@g" test/.terraformrc > $$tfconfig; \
cat $$tfconfig; \
schemafile=$$(mktemp); \
env TF_CLI_CONFIG_FILE=$$tfconfig terraform providers schema -json | \
sed 's@github.com/hewlettpackard/hpegl-pcbe-terraform-resources@hpegl@g' > $$schemafile; \
cat $$schemafile; \
tfplugindocs generate --providers-schema $$schemafile -provider-name hpegl;
rm __docs.tf

test:
Expand All @@ -42,9 +47,9 @@ testacc:

testacc-simulation:
go install -tags experimental,simulation ./cmd/...
tempfile=$$(mktemp); \
sed "s@__HOME__@${HOME}@g" test/.terraformrc > $$tempfile; \
env TF_ACC=1 env TF_CLI_CONFIG_FILE=$$tempfile \
tfconfig=$$(mktemp); \
sed "s@__HOME__@${HOME}@g" test/.terraformrc > $$tfconfig; \
env TF_ACC=1 env TF_CLI_CONFIG_FILE=$$tfconfig \
go test -v -tags simulation ./test/...

lint:
Expand Down

0 comments on commit 3f16737

Please sign in to comment.