DEV: explicit pnpm version in package.json and fix workflow (#8)

The github action for setting pnpm needs an explicit version for reference, and some pathing changes to get the workflow working.

Tested with successful workflow run that raised a PR at #12.

While testing this, I discovered that GJS files will have incorrect lineNumber referencing (e.g. ace:resize event) as we process those files first before we are able to run them through the parser (and by then, the lines differ from the source code). We'll need to figure out a different approach here for those

Author: tyb-talks

.github/workflows/update-app-events-data

@@ -2,8 +2,12 @@ name: Update App Events Data
 
 on:
   schedule:
-    - cron: '0 0 * * 1' # Run every Monday at 00:00 UTC
-  workflow_dispatch:     # Allow manual triggering
+    - cron: "0 0 * * 1" # Run every Monday at 00:00 UTC
+  workflow_dispatch: # Allow manual triggering
+
+permissions:
+  contents: write
+  pull-requests: write
 
 jobs:
   update-app-events-data:
@@ -12,12 +16,6 @@ jobs:
       - name: Checkout App Events Generator
         uses: actions/checkout@v4
 
-      - name: Checkout Discourse Core
-        uses: actions/checkout@v4
-        with:
-          repository: discourse/discourse
-          path: 'discourse'
-
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -31,14 +29,20 @@ jobs:
       - name: Install Dependencies
         run: pnpm install
 
+      - name: Checkout Discourse Core
+        uses: actions/checkout@v4
+        with:
+          repository: discourse/discourse
+          path: "discourse"
+
       - name: Create .env file
-        run: echo "DISCOURSE_CORE=./discourse" > .env
+        run: echo "DISCOURSE_CORE=discourse" > .env
 
       - name: Extract App Events
-        run: node scripts/extract_app_events.mjs
+        run: node ./scripts/extract_app_events.mjs
 
       - name: Generate App Events Details Doc
-        run: node scripts/create_app_events_doc_markdown.mjs
+        run: node ./scripts/create_app_events_docs_markdown.mjs
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v7
@@ -54,3 +58,7 @@ jobs:
             The data was extracted from the latest Discourse core repository.
           branch: dev-update-app-events-data
           delete-branch: true
+          add-paths: |
+            ./lib/app_events_docs_generator/app_events/app_events_details.json
+            ./lib/app_events_docs_generator/app_events/app_events_docs.md
+            ./lib/app_events_docs_generator/app_events/event-ids.yml

.github/workflows/update-app-events-data.yml

@@ -20,5 +20,6 @@
     "npm": "please-use-pnpm",
     "yarn": "please-use-pnpm",
     "pnpm": ">= 9"
-  }
+  },
+  "packageManager": "[email protected]"
 }

package.json

@@ -23,7 +23,7 @@ const EXCLUDED_DIR_PATTERNS = [
   "/discourse/vendor/",
   "/discourse/public/",
   "/discourse/spec/",
-  "/discourse/plugins/chat/test",
+  "/plugins/chat/test",
   "/discourse/plugins/discourse-deprecation-collector/",
 ];
 const UNPARSABLE_INDICATOR = "undefined";