Create Plugin: Add bundle stats workflow (#1357)

docusaurus/docs/get-started/set-up-development-environment.mdx

@@ -266,6 +266,34 @@ jobs:
           token: ${{ secrets.GH_PAT_TOKEN }}
 ```
 
+### The bundle stats workflow
+
+The bundle stats (`bundle-stats.yml`) workflow is intended to help developers keep an eye on the size of their plugins frontend assets. Changes in PRs trigger this workflow which will compare two webpack stats files; one from the default branch and the other from the PR. It then calculates differences between these assets sizes and posts a formatted comment to the PR giving an overview of any size differences.
+
+```yaml title="bundle-stats.yml"
+name: Bundle Stats
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  actions: read
+
+jobs:
+  compare:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - uses: grafana/plugin-actions/bundle-size@main
+```
+
 ## Extend configurations
 
 The `.config/` directory holds the preferred configuration for the different tools used to develop, test, and build a Grafana plugin. Although you can make changes, we recommend against doing so. Instead, follow the guidance in this topic to customize your tooling configs.

packages/create-plugin/templates/github/workflows/bundle-stats.yml

@@ -0,0 +1,21 @@
+name: Bundle Stats
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+  actions: read
+
+jobs:
+  compare:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - uses: grafana/plugin-actions/bundle-size@main

packages/create-plugin/templates/github/workflows/ci.yml

@@ -47,7 +47,12 @@ jobs:
       - name: Unit tests
         run: {{ packageManagerName }} run test:ci
       - name: Build frontend
-        run: {{ packageManagerName }} run build
+        run: |
+          if [ "$\{{ github.event_name }}" == "push" ] && [ "$\{{ github.ref }}" == "refs/heads/main" ]; then
+            {{ packageManagerName }} run build{{#if isNPM}} --{{/if}} --profile --json stats.json
+          else
+            {{ packageManagerName }} run build
+          fi
 
       - name: Check for backend
         id: check-for-backend
@@ -121,6 +126,14 @@ jobs:
           path: $\{{ steps.metadata.outputs.plugin-id }}
           retention-days: 5
 
+      - name: Upload stats.json artifact
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: actions/upload-artifact@v4
+        with:
+          name: main-branch-stats
+          path: stats.json
+          overwrite: true
+
   resolve-versions:
     name: Resolve e2e images
     runs-on: ubuntu-latest