Skip to content

chore: pin @grafana production deps to 12.4.2#2577

Open
jackw wants to merge 2 commits intomainfrom
chore/pin-grafana-deps-12.4.2
Open

chore: pin @grafana production deps to 12.4.2#2577
jackw wants to merge 2 commits intomainfrom
chore/pin-grafana-deps-12.4.2

Conversation

@jackw
Copy link
Copy Markdown
Collaborator

@jackw jackw commented Apr 15, 2026

Summary

Currently plugin scaffolds will fail dependency installs due to issues with publishing new versions of the packages in grafana/grafana to NPM. This PR addresses this by:

  • Pins @grafana/data, @grafana/i18n, @grafana/runtime, @grafana/ui, and @grafana/schema from ^12.4.0 to 12.4.2 in the common plugin template

Test plan

  • Scaffold a new plugin and verify package.json contains 12.4.2 for all @grafana/* production dependencies

🤖 Generated with Claude Code

@jackw jackw requested a review from a team as a code owner April 15, 2026 07:04
@jackw jackw requested review from ashharrison90, Copilot and joshhunt and removed request for Copilot April 15, 2026 07:04
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 15, 2026

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged and will trigger a new patch release.
NOTE: When merging a PR with the release label please avoid merging another PR. For further information see here.

@jackw jackw changed the title chore: pin @grafana production deps to 12.4.2 in plugin template chore: pin @grafana production deps to 12.4.2 Apr 15, 2026
@jackw jackw added patch Increment the patch version when merged release Create a release when this pr is merged labels Apr 15, 2026
Copilot AI review requested due to automatic review settings April 15, 2026 07:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Pins Grafana runtime production dependencies in the create-plugin common template to a known-good patch version to avoid scaffold install failures caused by upstream NPM publishing issues.

Changes:

  • Pin @grafana/{data,i18n,runtime,ui,schema} production deps in the common scaffold template from ^12.4.0 to 12.4.2.
  • Temporarily disable the test-updates job in CI.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
packages/create-plugin/templates/common/_package.json Pins core @grafana/* production dependencies to 12.4.2 in the scaffolded plugin template.
.github/workflows/ci.yml Comments out (disables) the test-updates CI job to avoid failures related to upstream publishing.

Comment thread .github/workflows/ci.yml
Comment on lines +171 to +176
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana. Put back to 5.27.1 once resolved.
# test-updates:
# name: Test create-plugin update command
# runs-on: ubuntu-x64
# if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
# needs: [test]
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description focuses on pinning @grafana/* deps, but this change also disables the test-updates CI job. Please either update the PR description/test plan to mention this CI behavior change, or keep the job enabled (e.g., with a targeted fix) so the PR matches its stated scope.

Copilot uses AI. Check for mistakes.
Comment thread .github/workflows/ci.yml
- name: Stop grafana docker (10.4.0)
run: docker compose down
working-directory: ./${{ env.WORKING_DIR }}
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana. Put back to 5.27.1 once resolved.
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment 'Put back to 5.27.1 once resolved' is misleading since the scaffold step inside the disabled block is already pinned to 5.27.1. Suggest rewording to clarify what should be reverted (e.g., re-enable the job) and ideally link to a tracking issue/incident for when to turn this back on.

Suggested change
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana. Put back to 5.27.1 once resolved.
# Temporarily disable this job to prevent failures caused by NPM package publishing issues in grafana/grafana.
# Re-enable `test-updates` once the upstream issue is resolved, and add or reference the relevant tracking issue/incident here.

Copilot uses AI. Check for mistakes.
Comment thread .github/workflows/ci.yml
Comment on lines +171 to +197
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana. Put back to 5.27.1 once resolved.
# test-updates:
# name: Test create-plugin update command
# runs-on: ubuntu-x64
# if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
# needs: [test]
# env:
# WORKING_DIR: 'myorg-nobackend-panel'
# steps:
# - name: Setup nodejs
# uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
# with:
# node-version: '24'

# - name: Scaffold plugin using the earliest create-plugin version mentioned in migrations
# run: npx -y @grafana/create-plugin@5.27.1 --plugin-name='no-backend' --org-name='myorg' --plugin-type='panel'

# - name: Install generated plugin dependencies
# run: npm install --no-audit
# working-directory: ./${{ env.WORKING_DIR }}

# - name: Download packed artifacts
# uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
# with:
# name: packed-artifacts
# path: ./packed-artifacts

Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting out an entire job removes it from CI and also makes it easy for the block to drift without YAML validation. If this is meant to be temporary, consider keeping the job definition active and disabling it with an explicit condition (e.g., a boolean if: guard at the job level) so it remains syntactically validated and easy to re-enable.

Suggested change
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana. Put back to 5.27.1 once resolved.
# test-updates:
# name: Test create-plugin update command
# runs-on: ubuntu-x64
# if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
# needs: [test]
# env:
# WORKING_DIR: 'myorg-nobackend-panel'
# steps:
# - name: Setup nodejs
# uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
# with:
# node-version: '24'
# - name: Scaffold plugin using the earliest create-plugin version mentioned in migrations
# run: npx -y @grafana/create-plugin@5.27.1 --plugin-name='no-backend' --org-name='myorg' --plugin-type='panel'
# - name: Install generated plugin dependencies
# run: npm install --no-audit
# working-directory: ./${{ env.WORKING_DIR }}
# - name: Download packed artifacts
# uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
# with:
# name: packed-artifacts
# path: ./packed-artifacts
# Temporarily disable to prevent failures due to NPM package publishing in grafana/grafana.
# Put back to 5.27.1 once resolved.
test-updates:
name: Test create-plugin update command
runs-on: ubuntu-x64
if: ${{ false }}
needs: [test]
env:
WORKING_DIR: 'myorg-nobackend-panel'
steps:
- name: Temporarily disabled
run: echo "Temporarily disabled pending upstream NPM package publishing issue in grafana/grafana."
# Re-enable the steps below once the upstream issue is resolved.
# - name: Setup nodejs
# uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
# with:
# node-version: '24'
# - name: Scaffold plugin using the earliest create-plugin version mentioned in migrations
# run: npx -y @grafana/create-plugin@5.27.1 --plugin-name='no-backend' --org-name='myorg' --plugin-type='panel'
# - name: Install generated plugin dependencies
# run: npm install --no-audit
# working-directory: ./${{ env.WORKING_DIR }}
# - name: Download packed artifacts
# uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
# with:
# name: packed-artifacts
# path: ./packed-artifacts

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown
Contributor

Playwright test results

Plugin Name Image Name Version Result Report
myorg-backend-datasource grafana-enterprise latest View report
myorg-nobackend-datasource grafana-enterprise latest View report
myorg-nobackend-panel grafana-enterprise latest View report
Troubleshooting

404 when clicking on View report

By default, the deploy-report-pages Action deploys reports to the gh-pages branch. However, you need to take an extra step to ensure that GitHub Pages can build and serve the site from this branch. To do so:

  1. Go to the Settings tab of your repository.
  2. In the left-hand sidebar, click on Pages.
  3. Under Source, select Deploy from a branch, then choose the gh-pages branch.

This action needs to be completed manually in order for your GitHub Pages site to be built and accessible from the gh-pages branch. Once configured, GitHub will automatically build and serve the site whenever new reports are deployed.

@grafana-plugins-platform-bot grafana-plugins-platform-bot bot moved this from 📬 Triage to 🔬 In review in Grafana Catalog Team Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

patch Increment the patch version when merged release Create a release when this pr is merged

Projects

Status: 🔬 In review

Development

Successfully merging this pull request may close these issues.

4 participants