ci: replace auto canary releases with pkg.pr.new (#2677)

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 2 people

.github/workflows/ci.yml

@@ -516,7 +516,12 @@ jobs:
   release:
     runs-on: ubuntu-latest
     needs: [test, generate-plugins]
-    if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci') && github.actor != 'dependabot[bot]'"
+    if: |
+      !contains(github.event.head_commit.message, 'ci skip')
+      && !contains(github.event.head_commit.message, 'skip ci')
+      && github.actor != 'dependabot[bot]'
+      && github.event_name == 'push'
+      && github.ref == 'refs/heads/main'
     name: Release packages
     env:
       NX_BRANCH: ${{ github.event.number || github.ref_name }}

.github/workflows/preview.yml

@@ -0,0 +1,35 @@
+name: Preview (pkg.pr.new)
+on:
+  pull_request:
+    types: [labeled, synchronize]
+permissions:
+  contents: read
+concurrency:
+  group: preview-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+jobs:
+  preview:
+    if: |
+      (github.event.action == 'labeled' && github.event.label.name == 'preview') ||
+      (github.event.action == 'synchronize' && contains(github.event.pull_request.labels.*.name, 'preview'))
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          # We need to fetch all branches and commits so that Nx affected has a base to compare against.
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: nrwl/nx-set-shas@afb73a62d26e41464e9254689e1fd6122ee683c1 # v5.0.1
+      - name: Setup nodejs
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version-file: '.nvmrc'
+          package-manager-cache: false
+
+      - name: Install dependencies
+        run: npm ci --no-audit
+      - name: Build all packages
+        run: npm run build
+      - name: Publish packages
+        run: npm exec pkg-pr-new publish -- './packages/*' --compact --commentWithSha --commentWithDev

CONTRIBUTING.md

@@ -13,6 +13,7 @@
   - [Contribute Documentation](#contribute-documentation)
   - [Contribute Code](#contribute-code)
 - Manage Something ✅🙆🏼💃👔
+  - [Preview Your Changes Before Release](#preview-your-changes-before-release)
   - [Create a Release](#create-a-release)
     - [Release Version Calculation](#release-version-calculation)
     - [Help! The release failed after the packages were published to the NPM registry](#help-the-release-failed-after-the-packages-were-published-to-the-npm-registry)
@@ -160,6 +161,33 @@ Once you've filed the PR:
 - If the maintainer decides to pass on your PR, they will thank you for the contribution and explain why they won't be accepting the changes. That's okay! We still really appreciate you taking the time to do it, and we don't take that lightly. 💚
 - If your PR gets accepted, it will be marked as such, and merged into the `main` branch soon after. Your contribution will be distributed to the masses next time the maintainers [create a release](#create-a-release)
 
+## Preview Your Changes Before Release
+
+Whilst developing new features it's possible to publish and install preview builds of every affected package using [pkg.pr.new](https://pkg.pr.new) — a free open-source service that builds and hosts SHA-keyed npm tarballs.
+
+To opt in:
+
+1. Add the `preview` label to your PR.
+2. CI builds every workspace and publishes the affected packages to pkg.pr.new.
+3. The [`pkg-pr-new[bot]`](https://github.com/apps/pkg-pr-new) posts a comment on the PR with one installable URL per affected package.
+
+Consumers install the preview by URL:
+
+```bash
+npm i https://pkg.pr.new/grafana/plugin-tools/@grafana/<package-name>@<commit-sha>
+```
+
+For CLI packages (`create-plugin`, `plugin-docs-cli`, `plugin-meta-extractor`, `plugin-types-bundler`, `react-detect`, `sign-plugin`), you can also run the binary directly without installing:
+
+```bash
+npx https://pkg.pr.new/grafana/plugin-tools/@grafana/<cli-package>@<commit-sha>
+```
+
+> [!IMPORTANT]
+> The URL keys off the commit SHA, not a real semver version. Any `package.json` reference to a pkg.pr.new URL must be swapped back to the published version once the PR is merged and released.
+
+When you push new commits to a PR with the `preview` label, the existing pkg.pr.new comment is updated in place with the new commit SHA.
+
 ## Create A Release
 
 Releases are managed by [Auto](https://intuit.github.io/auto/index) and PR labels.

package-lock.json

@@ -55,6 +55,7 @@
     "husky": "^9.1.7",
     "lerna": "^9.0.3",
     "lint-staged": "^16.2.7",
+    "pkg-pr-new": "^0.0.75",
     "prettier": "3.8.3",
     "publint": "^0.3.12",
     "rollup": "^4.57.1",

package.json

@@ -2,6 +2,7 @@
   "name": "@grafana/create-plugin",
   "version": "7.6.2",
   "repository": {
+    "type": "git",
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
   },

packages/create-plugin/package.json

@@ -25,6 +25,7 @@
   ],
   "homepage": "https://www.npmjs.com/package/@grafana/eslint-plugin-plugins",
   "repository": {
+    "type": "git",
     "directory": "packages/eslint-plugin-plugins",
     "url": "git+https://github.com/grafana/plugin-tools.git"
   },

packages/eslint-plugin-plugins/package.json

@@ -11,6 +11,7 @@
     "CHANGELOG.md"
   ],
   "repository": {
+    "type": "git",
     "directory": "packages/plugin-docs-cli",
     "url": "https://github.com/grafana/plugin-tools"
   },

packages/plugin-docs-cli/package.json

@@ -12,6 +12,7 @@
     "CHANGELOG.md"
   ],
   "repository": {
+    "type": "git",
     "directory": "packages/plugin-docs-parser",
     "url": "https://github.com/grafana/plugin-tools"
   },

packages/plugin-docs-parser/package.json

@@ -115,13 +115,13 @@ Beware that scenarios provided by @grafana/plugin-e2e needs to be work in older
 
 3. Push the changes in your local PR, create a draft PR in [grafana/plugin-tools](https://github.com/grafana/plugin-tools/) and add the labels `release` and `minor|patch`. CI will run all Playwright tests against a set of different Grafana versions. If not all of them pass, it may be because you've introduced a change that is no longer compatible with older versions of Grafana.
 
-4. Once CI passes, `auto` will publish a canary release to NPM. You can find the version number at the bottom of the PR description.
+4. Add the **`preview`** label to your PR. [pkg.pr.new](https://pkg.pr.new) will post a comment with an installable preview URL for `@grafana/plugin-e2e` (and any other affected packages). See [Preview Your Changes Before Release](../../CONTRIBUTING.md#preview-your-changes-before-release) in the root `CONTRIBUTING.md` for details.
 
 5. Install the pre-release of @grafana/plugin-e2e in [grafana/grafana](https://github.com/grafana/grafana) and run Playwright tests.
 
 ```bash
 # In your local grafana development folder
-yarn add @grafana/plugin-e2e@0.3.0-canary.623.aedff75.0
+yarn add https://pkg.pr.new/grafana/plugin-tools/@grafana/plugin-e2e@<commit-sha>
 yarn e2e:plugin
 ```