From 25e9a3f71135061affa10d83ba71659183ca0305 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Fri, 25 Oct 2024 11:00:13 -0700 Subject: [PATCH] Add automation for index docs --- .ci-mgmt.yaml | 1 + Makefile | 6 +++++- docs/_index.md | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.ci-mgmt.yaml b/.ci-mgmt.yaml index bc6b7aa0..2466c0ae 100644 --- a/.ci-mgmt.yaml +++ b/.ci-mgmt.yaml @@ -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 diff --git a/Makefile b/Makefile index 0cdd6e52..a17414b6 100644 --- a/Makefile +++ b/Makefile @@ -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: @@ -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} diff --git a/docs/_index.md b/docs/_index.md index a71a8c97..6af8bcf3 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -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