test-plugin-scaffolding.yml

name: 'Test plugin scaffolding'
on: [pull_request]

jobs:
  get-commands:
    name: Get scaffold commands
    if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
    runs-on: ubuntu-latest
    outputs:
      scaffoldCommands: ${{ steps.set-matrix.outputs.scaffoldCommands }}
    steps:
      - id: set-matrix
        run: echo "scaffoldCommands=[{\"cmd\":\"generate-app\",\"hasBackend\":false}, {\"cmd\":\"generate-app-backend\",\"hasBackend\":true}]" >> $GITHUB_OUTPUT
  generate-plugins:
    name: Test plugin scaffolding
    if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
    needs: get-commands
    runs-on: ubuntu-latest
    strategy:
      matrix:
        scaffoldCommand: ${{ fromJson(needs.get-commands.outputs.scaffoldCommands) }}
    env:
      NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
      NX_BRANCH: ${{ github.event.number || github.ref_name }}
    steps:
      - run: echo ${{ matrix.scaffoldCommand.cmd }}
      - run: echo ${{ matrix.scaffoldCommand.hasBackend }}

      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          # We need to fetch all branches and commits so that Nx affected has a base to compare against.
          fetch-depth: 0
      - uses: nrwl/nx-set-shas@v3
      - name: Setup .npmrc file for NPM registry
        uses: actions/setup-node@v3
        with:
          node-version: '18'
          registry-url: 'https://registry.npmjs.org'
          cache: 'npm'

      - name: Install package dependencies
        run: npm ci

      - name: Generate plugin
        run: npm exec nx run @grafana/create-plugin:${{ matrix.scaffoldCommand.cmd }}

      - name: Restore cached generated plugin dependencies
        id: cache-generated-deps-restore
        uses: actions/cache/restore@v3
        with:
          path: ./packages/create-plugin/generated/package-lock.json
          key: ${{ runner.os }}-${{ hashFiles('./packages/create-plugin/generated/package-lock.json') }}

      - name: Install generated plugin dependencies
        run: npm ci
        working-directory: ./packages/create-plugin/generated

      - name: Lint plugin frontend
        run: npm run lint
        working-directory: ./packages/create-plugin/generated

      - name: Build plugin frontend
        run: npm run build
        working-directory: ./packages/create-plugin/generated

      - name: Save generated plugin dependencies
        id: cache-generated-deps-save
        if: steps.cache-generated-deps-restore.outputs.cache-hit != 'true'
        uses: actions/cache/save@v3
        with:
          path: ./packages/create-plugin/generated/package-lock.json
          key: ${{ runner.os }}-${{ hashFiles('./packages/create-plugin/generated/package-lock.json') }}

      - uses: actions/setup-go@v4
        with:
          go-version: '~1.20'
          check-latest: true
          cache-dependency-path: ./packages/create-plugin/generated/go.sum
        if: ${{ matrix.scaffoldCommand.hasBackend == true }}

      - name: Build plugin backend
        uses: magefile/mage-action@v2
        with:
          version: latest
          args: -v build:linux
          workdir: ./packages/create-plugin/generated
        if: ${{ matrix.scaffoldCommand.hasBackend == true }}

        # - name: Restore cached generated plugin dependencies
        #   id: cache-generated-deps-restore
        #   uses: actions/cache/restore@v3
        #   with:
        #     path: |
        #       ./packages/create-plugin/generated/package-lock.json
        #       ./packages/create-plugin/generated/node_modules
        #     key: ${{ runner.os }}-generated-plugin-deps

        # - name: '@grafana/create-plugin - test an app plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-app && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint)
        # - name: '@grafana/create-plugin - test an app with backend plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-app-backend && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint && mage -v build:linux)
        # - name: '@grafana/create-plugin - test panel plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-panel && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint)
        # - name: '@grafana/create-plugin - test datasource plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-datasource && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint)
        # - name: '@grafana/create-plugin - test datasource with backend plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-datasource-backend && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint && mage -v build:linux)
        # - name: '@grafana/create-plugin - test scenes app plugin generation'
        #   run: npm exec nx run @grafana/create-plugin:generate-scenes-app && (cd ./packages/create-plugin/generated && npm install && npm run build && npm run lint)

        # - name: Save generated plugin dependencies
        #   id: cache-generated-deps-save
        #   if: steps.cache-generated-deps-restore.outputs.cache-hit != 'true'
        #   uses: actions/cache/save@v3
        #   with:
        #     path: |
        #       ./packages/create-plugin/generated/package-lock.json
        #       ./packages/create-plugin/generated/node_modules
        #     key: ${{ steps.cache-generated-deps-restore.outputs.cache-primary-key }}

        # - name: '@grafana/sign-plugin - use GRAFANA_ACCESS_POLICY_TOKEN to sign generated plugin'
        #   if: ${{ github.actor != 'dependabot[bot]' }}
        #   env:
        #     GRAFANA_ACCESS_POLICY_TOKEN: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
        #   run: node ../../sign-plugin/dist/bin/run.js --rootUrls http://www.example.com --signatureType private
        #   working-directory: ./packages/create-plugin/generated
        # - name: '@grafana/sign-plugin - use GRAFANA_API_KEY to sign generated plugin'
        #   if: ${{ github.actor != 'dependabot[bot]' }}
        #   env:
        #     GRAFANA_API_KEY: ${{ secrets.GRAFANA_API_KEY }}
        #   run: node ../../sign-plugin/dist/bin/run.js --rootUrls http://www.example.com --signatureType private
        #   working-directory: ./packages/create-plugin/generated