Skip to content

Commit 171f729

Browse files
authored
Fix: docs workflow (#108)
## What * Fix docs workflow ## Why (workflow was not working) ## Notes <!-- Add any notes here --> ## PR Checklist * [x] _I have read [CONTRIBUTING.md](https://github.com/codefresh-io/terraform-provider-codefresh/blob/master/README.md)._ * [x] _I have [allowed changes to my fork to be made](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)._ * [x] _I have added tests, assuming new tests are warranted_. * [x] _I have updated the Terraform docs in this repo, assuming any changes to the schema of Resources or Data Sources have been made._ * [x] _I understand that the `/test` comment will be ignored by the CI trigger [unless it is made by a repo admin or collaborator](https://codefresh.io/docs/docs/pipelines/triggers/git-triggers/#support-for-building-pull-requests-from-forks)._
1 parent fad55c1 commit 171f729

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

.github/workflows/docs.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ jobs:
1818
with:
1919
repository: ${{ github.event.pull_request.head.repo.full_name }}
2020
ref: ${{ github.event.pull_request.head.ref }}
21-
- run: |
21+
- name: Generate Docs
22+
run: |
2223
export PATH=$PATH:/home/runner/go/bin
2324
make docs-prepare
2425
tfplugindocs generate

GNUmakefile

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ HOSTNAME=codefresh.io
55
PKG_NAME=codefresh
66
NAMESPACE=app
77
BINARY=terraform-provider-${PKG_NAME}
8-
VERSION=0.2.1
98
OS_ARCH=darwin_amd64
109
TFPLUGINDOCS_VERSION=v0.14.1
1110

@@ -60,8 +59,8 @@ vet:
6059
fi
6160

6261
docs-prepare:
63-
@echo "==> Setting up docs..."
64-
which tfplugindocs || go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@${TFPLUGINDOCS_VERSION}
62+
@echo "==> Setting up tfplugindocs..."
63+
go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@${TFPLUGINDOCS_VERSION}
6564

6665
docs: docs-prepare
6766
@echo "==> Generating Provider Documentation..."

templates/index.md.tmpl

+1-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ For example:
2929
provider "codefresh" {
3030
api_key = "..."
3131
}
32-
3332
provider "codefresh" {
3433
api_key = "..."
3534
alias = "acme-dev"
@@ -43,4 +42,4 @@ resource "codefresh_pipeline" "pipeline-dev" {
4342
provider = codefresh.acme-dev
4443
... # Omited for brevity
4544
}
46-
```
45+
```

0 commit comments

Comments
 (0)