From 81ce948067bb25711f8b6715a545182e6e26a138 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Fri, 25 Oct 2024 10:56:18 -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 3074254c..08b02a61 100644 --- a/.ci-mgmt.yaml +++ b/.ci-mgmt.yaml @@ -13,6 +13,7 @@ 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 plugins: - name: std version: "1.6.2" diff --git a/Makefile b/Makefile index 7d5235ef..92860533 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 35c1795e..22b25714 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -13,6 +13,7 @@ The hcloud provider is available as a package in all Pulumi languages: * .NET: [`Pulumi.Hcloud`](https://www.nuget.org/packages/Pulumi.Hcloud) * Java: [`com.pulumi/hcloud`](https://central.sonatype.com/artifact/com.pulumi/hcloud) ## Overview + The Hetzner Cloud (hcloud) provider is used to interact with the resources supported by [Hetzner Cloud](https://www.hetzner.com/cloud). The provider needs to be configured with the proper credentials before it can be used. Use the navigation to the left to read about the available resources.