fix(update-schema): use Github Token to generate PR containing schema changes (#2260)

* fix(update-schema): add app configuration

* fix: remove temporary fix

* fix: add hash

* test: use GITHUB_TOKEN

* test: change provider schema

* test: fix workflow

* chore: update provider schema and issue templates

Auto-generated by schema consistency workflow

* fix: run workflow on specific path filters

* fix: make action generate a new PR for schema update

* test: test run workflow

* fix: run on PR

* fix: run on PR

* fix: revert testing changes

* fix: docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: simaarfania

.github/workflows/update-schema.yml

@@ -1,24 +1,26 @@
-name: enforce schema consistency
+name: create schema update PR
 
 on:
-  pull_request:
+  push:
+    branches:
+      - main
     paths:
       - 'internal/**'
       - 'pkg/**'
       - 'go.mod'
       - 'go.sum'
 
 jobs:
-  enforce-schema-consistency:
+  create-schema-update-pr:
     runs-on: ubuntu-latest
     permissions:
-      pull-requests: write
-      contents: read
+      contents: write  # Required to commit changes
+      pull-requests: write  # Required to create PRs
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          persist-credentials: false
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set up Go
         uses: actions/setup-go@f111f3307d8850f501ac008e886eec1fd1932a34 # v5.3.0
@@ -27,8 +29,6 @@ jobs:
 
       - name: Set up Terraform
         uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
-        with:
-          terraform_version: "1.12.2" # Ensure to use the same in generate_schema.sh
 
       - name: Generate current schema
         run: |
@@ -52,46 +52,43 @@ jobs:
             echo "Required provider_schema.json file not found"
           fi
 
-      - name: Update templates
+      - name: Update schema and templates
         if: steps.schema-check.outputs.schema_changed == 'true'
         run: |
+          # Update the provider schema
+          cp current_schema.json provider_schema.json
+
+          # Update templates
           go run scripts/generate_issue_template.go --update-schema
 
-      - name: Comment on PR
+      - name: Create Pull Request with schema updates
         if: steps.schema-check.outputs.schema_changed == 'true'
-        uses: actions/github-script@v7
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
         with:
-          script: |
-            const comment = `## 🔧 Schema Update Required
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: |
+            chore: update provider schema and issue templates
 
-            This PR introduces changes that affect the Terraform provider schema. The issue templates need to be updated.
+            Auto-generated by schema consistency workflow
+          title: 'chore: update provider schema and issue templates'
+          body: |
+            ## Automated Schema Update
 
-            ### 📋 Required Action
+            This PR was automatically created because recent changes to the codebase affected the Terraform provider schema.
 
-            Please run the generator to update templates:
+            ### Changes Made:
+            - Updated `provider_schema.json` with latest schema definitions
+            - Updated `.github/ISSUE_TEMPLATE/3-bug-report-enhanced.yml` with new schema options
 
-            \`\`\`bash
-            make generate-templates
-            \`\`\`
-
-            Then commit the updated files:
-            - \`provider_schema.json\`
-            - \`.github/ISSUE_TEMPLATE/3-bug-report-enhanced.yml\`
+            ### Triggered By:
+            - **Commit**: ${{ github.sha }}
+            - **Message**: ${{ github.event.head_commit.message }}
+            - **Author**: ${{ github.event.head_commit.author.name }}
 
             ---
-            *This comment was generated automatically because schema changes were detected.*`;
-
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: comment
-            });
-
-      - name: Fail if schema changes detected
-        if: steps.schema-check.outputs.schema_changed == 'true'
-        run: |
-          echo "❌ Schema changes detected - blocking merge until templates are updated"
-          echo "Run: make generate-templates"
-          echo "Then commit the updated files"
-          exit 1
+            🤖 *This PR was created automatically by the schema consistency workflow. Please review the changes before merging.*
+          branch: 'automated/update-schema'
+          delete-branch: true
+          base: main
+          committer: 'github-actions[bot] <github-actions[bot]@users.noreply.github.com>'
+          author: 'github-actions[bot] <github-actions[bot]@users.noreply.github.com>'

docs/resources/slo.md

@@ -9,7 +9,7 @@ description: |-
 
 # grafana_slo (Resource)
 
-Resource manages Grafana SLOs. 
+Resource manages Grafana SLOs.
 
 * [Official documentation](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/)
 * [API documentation](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/api/)

internal/resources/slo/resource_slo.go

@@ -28,7 +28,7 @@ var resourceSloID = common.NewResourceID(common.StringIDField("uuid"))
 func resourceSlo() *common.Resource {
 	schema := &schema.Resource{
 		Description: `
-Resource manages Grafana SLOs. 
+Resource manages Grafana SLOs.
 
 * [Official documentation](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/)
 * [API documentation](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/api/)

provider_schema.json

@@ -4,28 +4,6 @@ CURRENTDIR=$(realpath $(dirname $0))
 REPODIR="${CURRENTDIR}"/..
 WORKDIR=$(mktemp -d)
 
-TERRAFORM_VERSION="1.12.2"
-INSTALL_DIR="${REPODIR}"/testdata/terraform_"${TERRAFORM_VERSION}"
-
-OS="$(uname | tr '[:upper:]' '[:lower:]')"
-case "$OS" in
-  linux*)   OS="linux" ;;
-  darwin*)  OS="darwin" ;;
-  msys*|cygwin*|mingw*) OS="windows" ;;
-  *) echo "Unknown OS: $OS"; exit 1 ;;
-esac
-
-ARCH="$(uname -m)"
-case "$ARCH" in
-  x86_64) ARCH="amd64" ;;
-  i386|i686) ARCH="386" ;;
-  armv6l|armv7l) ARCH="arm" ;;
-  aarch64|arm64) ARCH="arm64" ;;
-  *) echo "Unknown Arch: $ARCH"; exit 1 ;;
-esac
-
-FILENAME=terraform_"${TERRAFORM_VERSION}"_"${OS}"_"${ARCH}".zip
-
 function finish {
     rm -rf "${WORKDIR}"
 }
@@ -52,11 +30,4 @@ echo '{"terraform":[{"required_providers":[{"provider":{"source":"grafana/grafan
 
 export TF_CLI_CONFIG_FILE=terraform.rc
 
-if [ ! -d "${INSTALL_DIR}" ]; then
-  mkdir -p "${INSTALL_DIR}"
-  
-  curl -o "${FILENAME}" https://releases.hashicorp.com/terraform/"${TERRAFORM_VERSION}"/"${FILENAME}"
-  unzip -qq -o "${FILENAME}" -d "${INSTALL_DIR}"
-fi
-
-"${INSTALL_DIR}/terraform" providers schema -json=true
+terraform providers schema -json=true