From 40eeebae973c6e4c345944fc21f21e7b69e34fb6 Mon Sep 17 00:00:00 2001 From: Pulumi Bot Date: Wed, 27 Mar 2024 05:54:24 +0000 Subject: [PATCH] [internal] Update GitHub Actions workflow files --- .github/workflows/main.yml | 27 ++++++++++++++++++++++ .github/workflows/prerelease.yml | 27 ++++++++++++++++++++++ .github/workflows/release.yml | 27 ++++++++++++++++++++++ .github/workflows/run-acceptance-tests.yml | 27 ++++++++++++++++++++++ 4 files changed, 108 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 486a0f1af4..155ab706f4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -264,6 +264,33 @@ jobs: Maintainer note: consult the [runbook](https://github.com/pulumi/platform-providers-team/blob/main/playbooks/tf-provider-updating.md) for dealing with any breaking changes. + - if: github.event_name == 'pull_request' + name: Check Configuration section + run: | + sed -n '/## Configuration/,$p' README.md | sed -n '/## Reference/q;p' >> config_section.txt + jq -r '.config[] | keys[]' < provider/cmd/pulumi-resource-${{ env.PROVIDER }}/schema.json >> keys.txt + EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) + { + echo "MISSING_CONFIG<<$EOF"; + xargs -I {} sh -c "grep -q {} config_section.txt || echo \\\`{}\\\` not found in Configuration section" < keys.txt + echo "$EOF"; + } >> "$GITHUB_ENV" + + - if: github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' + name: Comment on PR with Details of Configuration check + uses: thollander/actions-comment-pull-request@v2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + comment_tag: configurationCheck + message: >+ + ### Is README.md missing any configuration options? + + ${{ env.MISSING_CONFIG || 'No missing config!' }} + + + ${{ env.MISSING_CONFIG && 'Please add a description for each of these options to `README.md`.' }} + ${{ env.MISSING_CONFIG && 'Details about them can be found in either the upstream docs or `schema.json`.' }} + - name: Tar provider binaries run: tar -zcf ${{ github.workspace }}/bin/provider.tar.gz -C ${{ github.workspace }}/bin/ pulumi-resource-${{ env.PROVIDER }} diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 88125c7e33..5c276991e1 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -202,6 +202,33 @@ jobs: Maintainer note: consult the [runbook](https://github.com/pulumi/platform-providers-team/blob/main/playbooks/tf-provider-updating.md) for dealing with any breaking changes. + - if: github.event_name == 'pull_request' + name: Check Configuration section + run: | + sed -n '/## Configuration/,$p' README.md | sed -n '/## Reference/q;p' >> config_section.txt + jq -r '.config[] | keys[]' < provider/cmd/pulumi-resource-${{ env.PROVIDER }}/schema.json >> keys.txt + EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) + { + echo "MISSING_CONFIG<<$EOF"; + xargs -I {} sh -c "grep -q {} config_section.txt || echo \\\`{}\\\` not found in Configuration section" < keys.txt + echo "$EOF"; + } >> "$GITHUB_ENV" + + - if: github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' + name: Comment on PR with Details of Configuration check + uses: thollander/actions-comment-pull-request@v2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + comment_tag: configurationCheck + message: >+ + ### Is README.md missing any configuration options? + + ${{ env.MISSING_CONFIG || 'No missing config!' }} + + + ${{ env.MISSING_CONFIG && 'Please add a description for each of these options to `README.md`.' }} + ${{ env.MISSING_CONFIG && 'Details about them can be found in either the upstream docs or `schema.json`.' }} + - name: Tar provider binaries run: tar -zcf ${{ github.workspace }}/bin/provider.tar.gz -C ${{ github.workspace }}/bin/ pulumi-resource-${{ env.PROVIDER }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index bd4bdb281f..3f55de6109 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -216,6 +216,33 @@ jobs: Maintainer note: consult the [runbook](https://github.com/pulumi/platform-providers-team/blob/main/playbooks/tf-provider-updating.md) for dealing with any breaking changes. + - if: github.event_name == 'pull_request' + name: Check Configuration section + run: | + sed -n '/## Configuration/,$p' README.md | sed -n '/## Reference/q;p' >> config_section.txt + jq -r '.config[] | keys[]' < provider/cmd/pulumi-resource-${{ env.PROVIDER }}/schema.json >> keys.txt + EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) + { + echo "MISSING_CONFIG<<$EOF"; + xargs -I {} sh -c "grep -q {} config_section.txt || echo \\\`{}\\\` not found in Configuration section" < keys.txt + echo "$EOF"; + } >> "$GITHUB_ENV" + + - if: github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' + name: Comment on PR with Details of Configuration check + uses: thollander/actions-comment-pull-request@v2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + comment_tag: configurationCheck + message: >+ + ### Is README.md missing any configuration options? + + ${{ env.MISSING_CONFIG || 'No missing config!' }} + + + ${{ env.MISSING_CONFIG && 'Please add a description for each of these options to `README.md`.' }} + ${{ env.MISSING_CONFIG && 'Details about them can be found in either the upstream docs or `schema.json`.' }} + - name: Tar provider binaries run: tar -zcf ${{ github.workspace }}/bin/provider.tar.gz -C ${{ github.workspace }}/bin/ pulumi-resource-${{ env.PROVIDER }} diff --git a/.github/workflows/run-acceptance-tests.yml b/.github/workflows/run-acceptance-tests.yml index 90f9c448ac..209c00e18f 100644 --- a/.github/workflows/run-acceptance-tests.yml +++ b/.github/workflows/run-acceptance-tests.yml @@ -227,6 +227,33 @@ jobs: Maintainer note: consult the [runbook](https://github.com/pulumi/platform-providers-team/blob/main/playbooks/tf-provider-updating.md) for dealing with any breaking changes. + - if: github.event_name == 'pull_request' + name: Check Configuration section + run: | + sed -n '/## Configuration/,$p' README.md | sed -n '/## Reference/q;p' >> config_section.txt + jq -r '.config[] | keys[]' < provider/cmd/pulumi-resource-${{ env.PROVIDER }}/schema.json >> keys.txt + EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) + { + echo "MISSING_CONFIG<<$EOF"; + xargs -I {} sh -c "grep -q {} config_section.txt || echo \\\`{}\\\` not found in Configuration section" < keys.txt + echo "$EOF"; + } >> "$GITHUB_ENV" + + - if: github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' + name: Comment on PR with Details of Configuration check + uses: thollander/actions-comment-pull-request@v2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + comment_tag: configurationCheck + message: >+ + ### Is README.md missing any configuration options? + + ${{ env.MISSING_CONFIG || 'No missing config!' }} + + + ${{ env.MISSING_CONFIG && 'Please add a description for each of these options to `README.md`.' }} + ${{ env.MISSING_CONFIG && 'Details about them can be found in either the upstream docs or `schema.json`.' }} + - name: Tar provider binaries run: tar -zcf ${{ github.workspace }}/bin/provider.tar.gz -C ${{ github.workspace }}/bin/ pulumi-resource-${{ env.PROVIDER }}