ci/github-script/check-target-branch: convert to TypeScript

Only doing this one for now as a proof-of-concept.

(cherry picked from commit 2496d47b76)

.github/workflows/eval.yml

@@ -375,7 +375,7 @@ jobs:
         with:
           github-token: ${{ steps.app-token.outputs.token || github.token }}
           script: |
-            require('./nixpkgs/trusted/ci/github-script/check-target-branch.js')({
+            require('./nixpkgs/trusted/ci/github-script/check-target-branch.ts')({
               github,
               context,
               core,

.github/workflows/test.yml

@@ -77,7 +77,7 @@ jobs:
               '.github/workflows/pull-request-target.yml',
               '.github/workflows/test.yml',
               'ci/github-script/bot.js',
-              'ci/github-script/check-target-branch.js',
+              'ci/github-script/check-target-branch.ts',
               'ci/github-script/commits.js',
               'ci/github-script/get-pr-commit-details.js',
               'ci/github-script/lint-commits.js',

ci/github-script/check-target-branch.ts

@@ -1,3 +1,7 @@
+import type * as actionsCore from '@actions/core'
+import type { context as actionsContext } from '@actions/github'
+import type { GitHub } from '@actions/github/lib/utils'
+
 // TODO: should this be combined with the branch checks in prepare.js?
 // They do seem quite similar, but this needs to run after eval,
 // and prepare.js obviously doesn't.
@@ -7,39 +11,47 @@ const { readFile } = require('node:fs/promises')
 const { postReview, dismissReviews } = require('./reviews.js')
 
 const reviewKey = 'check-target-branch'
-/**
- * @param {{
- *  github: InstanceType<import('@actions/github/lib/utils').GitHub>,
- *  context: typeof import('@actions/github').context
- *  core: import('@actions/core')
- *  dry: boolean
- * }} CheckTargetBranchProps
- */
-async function checkTargetBranch({ github, context, core, dry }) {
-  /**
-   * @type {{
-   *  attrdiff: {
-   *   added: string[],
-   *   changed: string[],
-   *   removed: string[],
-   *  },
-   *  attrdiffByKernel: Record<string, {
-   *   added: string[],
-   *   changed: string[],
-   *   removed: string[],
-   *  }>,
-   *  attrdiffByPlatform: Record<string, {
-   *   added: string[],
-   *   changed: string[],
-   *   removed: string[],
-   *  }>,
-   *  labels: Record<string, boolean>,
-   *  rebuildCountByKernel: Record<string, number>,
-   *  rebuildsByKernel: Record<string, string[]>,
-   *  rebuildsByPlatform: Record<string, string[]>,
-   * }}
-   */
-  const changed = JSON.parse(
+
+type ChangedPaths = {
+  attrdiff: {
+    added: string[]
+    changed: string[]
+    removed: string[]
+  }
+  attrdiffByKernel: Record<
+    string,
+    {
+      added: string[]
+      changed: string[]
+      removed: string[]
+    }
+  >
+  attrdiffByPlatform: Record<
+    string,
+    {
+      added: string[]
+      changed: string[]
+      removed: string[]
+    }
+  >
+  labels: Record<string, boolean>
+  rebuildCountByKernel: Record<string, number>
+  rebuildsByKernel: Record<string, string[]>
+  rebuildsByPlatform: Record<string, string[]>
+}
+
+async function checkTargetBranch({
+  github,
+  context,
+  core,
+  dry,
+}: {
+  github: InstanceType<typeof GitHub>
+  context: typeof actionsContext
+  core: typeof actionsCore
+  dry: boolean
+}) {
+  const changed: ChangedPaths = JSON.parse(
     await readFile('comparison/changed-paths.json', 'utf-8'),
   )
   const pull_number = context.payload.pull_request?.number
@@ -153,7 +165,7 @@ async function checkTargetBranch({ github, context, core, dry }) {
       reviewKey,
     })
   } else if (rebuildsAllTests && !isExemptKernelUpdate) {
-    let branchText
+    let branchText: string
     if (base === 'master' && maxRebuildCount >= 500) {
       branchText = '(probably either `staging-nixos` or `staging`)'
     } else if (base === 'master') {

ci/github-script/run

@@ -112,7 +112,7 @@ program
   .argument('<repo>', 'Name of the GitHub repository to run on (Example: nixpkgs)')
   .argument('<pr>', 'Number of the Pull Request to run on')
   .action(async (owner, repo, pr, options) => {
-    const checkTargetBranch = (await import('./check-target-branch.js')).default
+    const checkTargetBranch = (await import('./check-target-branch.ts')).default
     await run(checkTargetBranch, owner, repo, pr, options)
   })