Test config comment 1

.github/workflows/run-acceptance-tests.yml

@@ -225,6 +225,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-github/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 }}

README.md

@@ -52,6 +52,15 @@ The following configuration points are available:
 - `github:organization` - (Deprecated) This behaves the same as owner, which should be used instead. This value can also 
   be sourced from the `GITHUB_ORGANIZATION` environment variable.
 
+appAuth not found in Configuration section
+insecure not found in Configuration section
+maxRetries not found in Configuration section
+parallelRequests not found in Configuration section
+readDelayMs not found in Configuration section
+retryDelayMs not found in Configuration section
+retryableErrors not found in Configuration section
+writeDelayMs not found in Configuration section
+
 ## Reference
 
 For further information, please visit [the GitHub provider docs](https://www.pulumi.com/docs/intro/cloud-providers/github)