Skip to content

Fix: docs workflow #108

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 11 commits into from
Mar 6, 2023
Merged

Fix: docs workflow #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6a4b43e
Update docs.yaml
korenyoni Mar 6, 2023
cae2825
Update index.md.tmpl
korenyoni Mar 6, 2023
7b79c59
Update docs.yaml
korenyoni Mar 6, 2023
a1b2068
Update docs.yaml
korenyoni Mar 6, 2023
957ee0d
Update GNUmakefile
korenyoni Mar 6, 2023
92f06f3
Update GNUmakefile
korenyoni Mar 6, 2023
a6ffced
Update GNUmakefile
korenyoni Mar 6, 2023
4032309
Update GNUmakefile
korenyoni Mar 6, 2023
661d640
Update GNUmakefile
korenyoni Mar 6, 2023
b0d8743
Update docs.yaml
korenyoni Mar 6, 2023
669c2e7
Update docs.yaml
korenyoni Mar 6, 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
3 changes: 2 additions & 1 deletion .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ jobs:
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
- run: |
- name: Generate Docs
run: |
export PATH=$PATH:/home/runner/go/bin
make docs-prepare
tfplugindocs generate
Expand Down
5 changes: 2 additions & 3 deletions GNUmakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ HOSTNAME=codefresh.io
PKG_NAME=codefresh
NAMESPACE=app
BINARY=terraform-provider-${PKG_NAME}
VERSION=0.2.1
OS_ARCH=darwin_amd64
TFPLUGINDOCS_VERSION=v0.14.1

Expand Down Expand Up @@ -60,8 +59,8 @@ vet:
fi

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

docs: docs-prepare
@echo "==> Generating Provider Documentation..."
Expand Down
3 changes: 1 addition & 2 deletions templates/index.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ For example:
provider "codefresh" {
api_key = "..."
}

provider "codefresh" {
api_key = "..."
alias = "acme-dev"
Expand All @@ -43,4 +42,4 @@ resource "codefresh_pipeline" "pipeline-dev" {
provider = codefresh.acme-dev
... # Omited for brevity
}
```
```