Skip to content

Commit

Permalink
Add automation for index docs (#603)
Browse files Browse the repository at this point in the history
This PR automates docsgen for this provider's installation doc.

Followup on pulumi/home#3598.
  • Loading branch information
guineveresaenger authored Oct 25, 2024
2 parents af5c725 + 25e9a3f commit 38b3a4f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions .ci-mgmt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ actions:
run: |
cd provider && go test -v -json -count=1 -cover -timeout 2h -tags=${{ matrix.language }} -parallel 4 . 2>&1 | tee /tmp/gotest.log | gotestfmt
pulumiConvert: 1
registryDocs: true
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ development: install_plugins provider build_sdks install_sdks

build: install_plugins provider build_sdks install_sdks

build_sdks: build_nodejs build_python build_dotnet build_go build_java
build_sdks: build_nodejs build_python build_dotnet build_go build_java build_registry_docs

install_go_sdk:

Expand Down Expand Up @@ -96,6 +96,10 @@ build_python: upstream
cd ./bin && \
../venv/bin/python -m build .

# Run the bridge's registry-docs command to generated the content of the installation docs/ folder at provider repo root
build_registry_docs:
$(WORKING_DIR)/bin/$(TFGEN) registry-docs --out $(WORKING_DIR)/docs

clean:
rm -rf sdk/{dotnet,nodejs,go,python}

Expand Down
1 change: 1 addition & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The keycloak provider is available as a package in all Pulumi languages:
* .NET: [`Pulumi.Keycloak`](https://www.nuget.org/packages/Pulumi.Keycloak)
* Java: [`com.pulumi/keycloak`](https://central.sonatype.com/artifact/com.pulumi/keycloak)
## Overview

The Keycloak provider can be used to interact with [Keycloak](https://www.keycloak.org/).
## A note for users of the legacy Wildfly distribution

Expand Down

0 comments on commit 38b3a4f

Please sign in to comment.