Implementation of project board automations

.github/sync.yml

@@ -12,10 +12,12 @@ group:
       - source: automations/data/
         dest: automations/data/
       # Synced workflows
-      - source: .github/workflows/new_issues.yml
-        dest: .github/workflows/new_issues.yml
-      - source: .github/workflows/new_prs.yml
-        dest: .github/workflows/new_prs.yml
+      - source: .github/workflows/issue_automations.yml
+        dest: .github/workflows/issue_automations.yml
+      - source: .github/workflows/pr_automations.yml
+        dest: .github/workflows/pr_automations.yml
+      - source: .github/workflows/pr_automations_init.yml
+        dest: .github/workflows/pr_automations_init.yml
       - source: .github/workflows/label_new_pr.yml
         dest: .github/workflows/label_new_pr.yml
       - source: .github/workflows/pr_label_check.yml

.github/workflows/issue_automations.yml

@@ -0,0 +1,38 @@
+# Runs all automations related to issue events.
+#
+# See `pr_automations_init.yml` and `pr_automations.yml` for the corresponding
+# implementation for PRs.
+name: Issue automations
+
+on:
+  issues:
+    types:
+      - opened
+      - reopened
+      - closed
+      - assigned
+      - labeled
+      - unlabeled
+
+jobs:
+  run:
+    name: Perform issue automations
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup CI env
+        uses: ./.github/actions/setup-env
+        with:
+          setup_python: false
+          install_recipe: node-install
+
+      - name: Perform issue automations
+        run: |
+          echo "$EVENT_PAYLOAD" > event.json
+          pnpm issues --event_name ${{ github.event_name }} --event_action ${{ github.event.action }}
+          rm event.json
+        env:
+          EVENT_PAYLOAD: ${{ toJson(github.event) }}M
+        working-directory: automations/js

.github/workflows/pr_automations.yml

@@ -0,0 +1,78 @@
+# Runs all automations related to PR events.
+#
+# See `issue_automations_init.yml` for the corresponding implementation for
+# issues.
+#
+# The automations for PR events are a little more complex than those for issues
+# because PRs are a less secure environment. To avoid leaking secrets, we need
+# to run automations with code as it appears on `main`.
+#
+# `pull_request_target` serves this purpose but there is no corresponding
+# `_target` version for `pull_request_review`. So we take this roundabout
+# approach:
+#
+# This workflow waits for the `pr_automations_init.yml` workflow to complete and
+# then uses its exports to run automations from main, with access to secrets.
+#
+# ...continued from `pr_automations_init.yml`
+#
+# 4. This workflow runs after `pr_automations_init.yml` workflow completes.
+# 5. It downloads the artifacts from that workflow run.
+# 6. It extracts the files, loads the env vars and runs the automation script.
+
+name: PR automations
+
+on:
+  workflow_run:
+    workflows:
+      - PR automations init
+    types:
+      - completed
+
+jobs:
+  run:
+    name: Perform PR automations
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup CI env
+        uses: ./.github/actions/setup-env
+        with:
+          setup_python: false
+          install_recipe: node-install
+
+      # This step was copied from the GitHub docs.
+      # Ref: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#using-data-from-the-triggering-workflow
+      - name: Download artifact
+        uses: actions/github-script@v6
+        with:
+          script: |
+            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: context.payload.workflow_run.id,
+            });
+            let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "event_info"
+            })[0];
+            let download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            let fs = require('fs');
+            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/event_info.zip`, Buffer.from(download.data));
+
+      - name: Perform PR automations
+        run: |
+          unzip event_info.zip
+          source event_info.env
+          pnpm prs --event_name "$EVENT_NAME" --event_action "$EVENT_ACTION"
+          rm event_info.env
+          rm event.json
+        env:
+          EVENT_PAYLOAD: ${{ toJson(github.event) }}
+        working-directory: automations/js

.github/workflows/pr_automations_init.yml

@@ -0,0 +1,54 @@
+# Initialises all automations related to PR events.
+#
+# See `issue_automations_init.yml` for the corresponding implementation for
+# issues.
+#
+# The automations for PR events are a little more complex than those for issues
+# because PRs are a less secure environment. To avoid leaking secrets, we need
+# to run automations with code as it appears on `main`.
+#
+# `pull_request_target` serves this purpose but there is no corresponding
+# `_target` version for `pull_request_review`. So we take this roundabout
+# approach:
+#
+# 1. This workflow runs for the events and their subtypes we are interested in.
+# 2. It saves the event payload to a JSON file and the event name and action to
+#    an environment file.
+# 3. It uploads the JSON file and the environment files as artifacts.
+#
+# continued in `pr_automations.yml`...
+
+name: PR automations init
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - edited
+      - converted_to_draft
+      - ready_for_review
+      - closed
+  pull_request_review:
+
+jobs:
+  run:
+    name: Save event info
+    runs-on: ubuntu-latest
+    steps:
+      - name: Save event info
+        run: |
+          mkdir -p ./pr
+          echo "$EVENT_PAYLOAD" > ./pr/event.json
+          echo "export EVENT_NAME=$EVENT_NAME" > ./pr/event_info.env
+          echo "export EVENT_ACTION=$EVENT_ACTION" >> ./pr/event_info.env
+        env:
+          EVENT_PAYLOAD: ${{ toJson(github.event) }}
+          EVENT_NAME: ${{ github.event_name }}
+          EVENT_ACTION: ${{ github.event.action }}
+
+      - name: Upload event info as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: event_info
+          path: pr/

automations/js/.gitignore

@@ -0,0 +1,2 @@
+# Event data payload used by project automations
+event.json

automations/js/package.json

@@ -4,14 +4,18 @@
   "private": true,
   "version": "0.0.0",
   "dependencies": {
-    "@octokit/rest": "19.0.7",
     "axios": "^1.0.0",
     "js-yaml": "^4.1.0",
     "k6": "0.0.0",
-    "nunjucks": "^3.2.4"
+    "nunjucks": "^3.2.4",
+    "octokit": "^3.1.2",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@actions/core": "^1.10.0",
     "@actions/github": "^5.1.1"
+  },
+  "scripts": {
+    "issues": "node src/project_automation/issues.mjs"
   }
 }

automations/js/src/count_user_reviewable_prs.js

@@ -4,7 +4,7 @@
  * Return their Slack username and PR count, if found.
  *
  * @param {Object} options
- * @param {import('@octokit/rest').Octokit} options.github
+ * @param {import('octokit').Octokit} options.github
  * @param {import('@actions/github')['context']} options.context
  * @param {import('@actions/core')} options.core
  */

automations/js/src/last_week_tonight.mjs

@@ -8,29 +8,24 @@ import { resolve } from 'path'
 
 import yaml from 'js-yaml'
 import axios from 'axios'
-import { Octokit } from '@octokit/rest'
 
 import { escapeHtml } from './html.mjs'
+import { getOctokit } from './utils/octokit.mjs'
 
 /* Environment variables */
 
-/** the personal access token for the GitHub API */
-const pat = process.env.ACCESS_TOKEN
 /** the username for the Make site account making the post */
 const username = process.env.MAKE_USERNAME
 /** the application password, not login password, for the Make site */
 const password = process.env.MAKE_PASSWORD
 
-if (!pat) {
-  console.log('GitHub personal access token "ACCESS_TOKEN" is required.')
-}
 if (!username) {
   console.log('Make site username "MAKE_USERNAME" is required.')
 }
 if (!password) {
   console.log('Make site application password "MAKE_PASSWORD" is required.')
 }
-if (!(pat && username && password)) process.exit(1)
+if (!(username && password)) process.exit(1)
 
 /* Read GitHub information from the data files */
 
@@ -51,7 +46,7 @@ const [startDate] = new Date(new Date().getTime() - msInWeeks(1))
 
 /* GitHub API */
 
-const octokit = new Octokit({ auth: pat })
+const octokit = getOctokit()
 const mergedPrsQ = (repo) =>
   `repo:${org}/${repo} is:pr is:merged merged:>=${startDate}`
 const closedIssuesQ = (repo) =>

automations/js/src/migrate_issues.js

@@ -1,6 +1,6 @@
 const fs = require('fs')
 
-const { Octokit } = require('@octokit/rest')
+const { Octokit } = require('octokit')
 
 // TODO: add auth token
 const octokit = new Octokit({

automations/js/src/project_automation/issues.mjs

@@ -0,0 +1,77 @@
+/**
+ * This module handles all events related to issues.
+ *
+ * Invoke it from the CLI with
+ * - the event name as the `--event_name` argument
+ * - the event action as the `--event_action` argument
+ * - the event payload in the `event.json` file in the project root
+ */
+
+import { getBoard } from '../utils/projects.mjs'
+import { getEvent } from '../utils/event.mjs'
+
+const { eventAction, eventPayload } = getEvent()
+
+if (
+  eventPayload.issue.labels.some((label) => label.name === '🧭 project: thread')
+)
+  // Do not add project threads to the Backlog board.
+  process.exit(0)
+
+const backlogBoard = await getBoard('Backlog')
+const columns = backlogBoard.columns // computed property
+
+// Create new, or get the existing, card for the current issue.
+const card = await backlogBoard.addCard(eventPayload.issue.node_id)
+
+/**
+ * Set the "Priority" custom field based on the issue's labels.
+ */
+const syncPriority = async () => {
+  const priority = eventPayload.issue.labels.find((label) =>
+    label.name.includes('priority')
+  )?.name
+  if (priority)
+    await backlogBoard.setCustomChoiceField(card.id, 'Priority', priority)
+  if (priority === '🟥 priority: critical')
+    await backlogBoard.moveCard(card.id, columns.ToDo)
+}
+
+switch (eventAction) {
+  case 'opened':
+  case 'reopened':
+    if (
+      eventPayload.issue.labels.some(
+        (label) => label.name === '⛔ status: blocked'
+      )
+    )
+      await backlogBoard.moveCard(card.id, columns.Blocked)
+    else await backlogBoard.moveCard(card.id, columns.Backlog)
+
+    await syncPriority()
+    break
+
+  case 'closed':
+    if (eventPayload.issue.state_reason === 'completed')
+      await backlogBoard.moveCard(card.id, columns.Done)
+    else await backlogBoard.moveCard(card.id, columns.Discarded)
+    break
+
+  case 'assigned':
+    if (card.status === columns.Backlog)
+      await backlogBoard.moveCard(card.id, columns.ToDo)
+    break
+
+  case 'labeled':
+    if (eventPayload.label.name === '⛔ status: blocked')
+      await backlogBoard.moveCard(card.id, columns.Blocked)
+    await syncPriority()
+    break
+
+  case 'unlabeled':
+    if (eventPayload.label.name === '⛔ status: blocked')
+      // TODO: Move back to the column it came from.
+      await backlogBoard.moveCard(card.id, columns.Backlog)
+    await syncPriority()
+    break
+}