Merge pull request #8 from grafana/verify-dist-in-ci

Verify if dist directory is consistent with the changes or not in CI

Author: DefCon-007

.github/workflows/check-dist.yaml

@@ -0,0 +1,69 @@
+# Originally taken from: https://github.com/actions/typescript-action/blob/cebb7a99fe3172ff475be1ca488335e710c873c3/.github/workflows/check-dist.yml
+#
+# In TypeScript actions, `dist/` is a special directory. When you reference
+# an action with the `uses:` property, `dist/index.js` is the code that will be
+# run. For this project, the `dist/index.js` file is transpiled from other
+# source files. This workflow ensures the `dist/` directory contains the
+# expected transpiled code.
+#
+# If this workflow is run from a feature branch, it will act as an additional CI
+# check and fail if the checked-in `dist/` directory does not match what is
+# expected from the build.
+name: Check Transpiled JavaScript
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  check-dist:
+    name: Check dist/
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        id: setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+          cache: npm
+
+      - name: Install Dependencies
+        id: install
+        run: npm ci
+
+      - name: Build dist/ Directory
+        id: build
+        run: npm run package
+
+      # This will fail the workflow if the `dist/` directory is different than
+      # expected.
+      - name: Compare Directories
+        id: diff
+        run: |
+          if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then
+            echo "Detected uncommitted changes after build. See status below:"
+            git diff --ignore-space-at-eol --text dist/
+            exit 1
+          fi
+
+      # If `dist/` was different than expected, upload the expected version as a
+      # workflow artifact.
+      - if: ${{ failure() && steps.diff.outcome == 'failure' }}
+        name: Upload Artifact
+        id: upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

.node-version

@@ -0,0 +1 @@
+20.12.2

dist/index.js

@@ -34695,6 +34695,14 @@ exports.validateTestPaths = void 0;
 // Common helper functions used in the action 
 const child_process_1 = __nccwpck_require__(2081);
 async function validateTestPaths(testPaths) {
+    /**
+     * Validates the test paths by running `k6 inspect --execution-requirements` on each test file.
+     * A test path is considered valid if the command returns an exit code of 0.
+     *
+     * @export
+     * @param {string[]} testPaths - List of test paths to validate
+     * @return {Promise<string[]>} - List of valid test paths
+     */
     if (testPaths.length === 0) {
         throw new Error('No test files found');
     }