Drop the GitHub Pages deployment logic

I don't need a secret to use that, so it's pointless to even bother.

Author: dead-claudia

.github/workflows/deploy.yml

@@ -12,7 +12,6 @@ on:
         type: choice
         options:
         - npm
-        - github-pages
         required: true
       packageName:
         type: string

README.md

@@ -27,13 +27,6 @@ It's a multi-step process.
          type: npm
          token: ${{ secrets.DEPLOY_TOKEN }}
      ```
-   - Deploy to GitHub Pages:
-     ```yml
-     - uses: MithrilJS/infra/deploy@main
-       with:
-         type: github-pages
-         token: ${{ secrets.DEPLOY_TOKEN }}
-     ```
    To deploy a package not located in the repo root, set the `root_dir` option:
    ```yml
    with:

RUNBOOK.md

@@ -3,7 +3,6 @@
 - [Create a new deployment token](#create-a-new-deployment-token)
 - [Update an existing deployment token](#update-an-existing-deployment-token)
 - [Create a new npm token](#create-a-new-npm-token)
-- [Update the org-level GitHub Pages token](#update-the-org-level-github-pages-token)
 
 ## Create a new deployment token
 
@@ -80,35 +79,3 @@ For now, create a classic token of type "Automation". We can switch to the fine-
 9. Come up with a unique, descriptive name, and use that for the name.
 10. Paste the copied token into the "Secret" field.
 11. Click "Add secret".
-
-## Update the org-level GitHub Pages token
-
-This is for a given repository `$REPO`, like `MithrilJS/mithril.js`.
-
-If the token is yours:
-
-1. [Go to your developer settings](https://github.com/settings/apps), click the "Personal access tokens" navigation dropdown, and click "Fine-grained tokens".
-2. Set the expiration to 1 year from now. This is the longest the selector will let you choose.
-3. Go to the bottom of the page and click "Regenerate token".
-4. Copy the resulting token.
-5. [Go to this repo's Actions secrets page.](https://github.com/MithrilJS/infra/settings/secrets/actions)
-6. In "Repository secrets", find `GH_PAGES_TOKEN` and click its edit icon.
-7. Paste the copied token into the "Secret" field.
-8. Click "Update secret".
-
-If the token is not yours:
-
-1. Create a new [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new).
-2. For the name, use `$REPO deploy pages`. Feel free to shorten the repo name if needed - it's just important that you're able to find it
-3. Set the expiration to 1 year from now. This is the longest the selector will let you choose.
-4. For the description, it's up to you.
-5. Set the resource owner to `@MithrilJS`.
-6. In repository access, click "Only select repositories", open the "Select repositories" dropdown, and search and add the following repositories:
-   - `MithrilJS/mithril.js`
-7. In "Permissions", set Repository Permissions > Deployments to "Read and write"
-8. Go to the bottom of the page and click "Generate token".
-9. Copy the resulting token.
-10. [Go to this repo's Actions secrets page.](https://github.com/MithrilJS/infra/settings/secrets/actions)
-11. In "Repository secrets", find `GH_PAGES_TOKEN` and click its edit icon.
-12. Paste the copied token into the "Secret" field.
-13. Click "Update secret".

deploy/action.yml

@@ -5,7 +5,6 @@ inputs:
     description: |
       The type of deployment to perform. Currently must be one of the following:
       - `npm`
-      - `github-pages`
     required: true
   root_dir:
     description: The directory to the root. Defaults to `GITHUB_WORKSPACE`.

lib/config.js

@@ -1,4 +1,4 @@
-/** @type {Record<"npm" | "github-pages", Record<string, Project>>} */
+/** @type {Record<"npm", Record<string, Project>>} */
 export const projects = {
     "npm": {
         // "ospec": {
@@ -29,33 +29,6 @@ export const projects = {
             tokenName: "INFRA_TEST_TOKEN",
         },
     },
-
-    // Keys should be locations. A `CNAME` will be checked for in the deployment if the key isn't
-    // of the form `mithriljs.github.io/REPO`.
-    "github-pages": {
-        // "mithril.js.org": {
-        //     location: "MithrilJS/mithril.js",
-        //     tokenExpiryDate: d(1970, 1, 1),
-        //     tokenName: "GH_PAGES_TOKEN",
-        // },
-        "mithriljs.github.io/docs": {
-            location: "MithrilJS/docs",
-            tokenExpiryDate: d(2025, 9, 23),
-            tokenName: "GH_PAGES_TOKEN",
-        },
-
-        // These are only for testing purposes.
-        "example.com": {
-            location: "MithrilJS/infra",
-            tokenExpiryDate: d(1970, 1, 1),
-            tokenName: "INFRA_TEST_TOKEN",
-        },
-        "mithriljs.github.io/infra": {
-            location: "MithrilJS/infra",
-            tokenExpiryDate: d(1970, 1, 1),
-            tokenName: "INFRA_TEST_TOKEN",
-        },
-    },
 }
 
 export const localTokenExpiryDates = {

lib/entry/deploy.js

@@ -5,7 +5,6 @@ import artifact from "@actions/artifact"
 import {fail, getRequiredEnv, run, validateDeployPayload} from "../util.js"
 import {getRequest} from "../api-client.js"
 
-import {packGitHubPages} from "../pack/github-pages.js"
 import {packNpm} from "../pack/npm.js"
 
 run(async() => {
@@ -40,10 +39,6 @@ run(async() => {
                 artifactFile = await packNpm(rootDir, repo)
                 break
 
-            case "github-pages":
-                artifactFile = await packGitHubPages(rootDir, repo)
-                break
-
             default:
                 return fail(`\`${JSON.stringify(type)}\` is not a valid input type.`)
         }

lib/entry/handle-deploy.js

@@ -8,6 +8,8 @@ import * as path from "node:path"
 import {extractJsonFields, fail, run, validateDeployPayload} from "../util.js"
 import {localTokenExpiryDates, projects} from "../config.js"
 
+import {deployToNpm} from "../deploy/npm.js"
+
 async function getPayload() {
     switch (process.env.GITHUB_EVENT_NAME) {
         case "workflow_dispatch": {
@@ -67,15 +69,10 @@ function getDeployToken(payload) {
 run(async() => {
     const payload = await getPayload()
     const deployToken = getDeployToken(payload)
-    let deployFn
 
     if (payload.type === "npm") {
-        deployFn = (await import("../deploy/npm.js")).deployToNpm
-    } else if (payload.type === "github-pages") {
-        deployFn = (await import("../deploy/github-pages.js")).deployToGitHubPages
+        return deployToNpm(payload, deployToken)
     } else {
         throw new Error(`Unimplemented payload type: ${payload.type}`)
     }
-
-    return deployFn(payload, deployToken)
 })

lib/pack/github-pages.js

@@ -137,7 +137,7 @@ export function getProject(payload) {
 /**
  * @typedef DeployPayload
  * @property {string} repo
- * @property {"npm" | "github-pages"} type
+ * @property {keyof typeof import("./config.js")["projects"]} type
  * @property {string} target
  * @property {string} tarballName
  * @property {number} artifactId
@@ -160,7 +160,7 @@ export function validateDeployPayload(payload) {
         workflowRunId: "number",
         buildVersion: "number",
     })
-    if (!(/^(?:npm|github-pages)$/).test(payload.type)) {
+    if (!(/^(?:npm)$/).test(payload.type)) {
         throw new Error(`Unknown payload type: ${payload.type}`)
     }
     return payload

lib/tar-builder.js

@@ -2,57 +2,14 @@ import {
     assertFail,
     assertTarballMissing,
     assertTarballPresent,
-    assertTarballValid,
     p,
     printReport,
     suite,
     test,
 } from "./utils.js"
 
-import {packGitHubPages} from "../lib/pack/github-pages.js"
 import {packNpm} from "../lib/pack/npm.js"
 
-await suite("packGitHubPages", async() => {
-    await test("cname present and allowlisted, repo match", async() => {
-        await packGitHubPages(p("./package-with-cname"), "MithrilJS/infra")
-        await assertTarballValid("artifact.tar", [
-            "CNAME",
-            "lib/",
-            "lib/index.js",
-            "package.json",
-        ])
-    })
-
-    await test("cname present yet not allowlisted, repo match", async() => {
-        await assertFail(() => packGitHubPages(p("./package-wrong-cname"), "MithrilJS/infra"))
-        await assertTarballMissing("artifact.tar")
-    })
-
-    await test("cname missing, repo match", async() => {
-        await packGitHubPages(p("./package-no-cname"), "MithrilJS/infra")
-        await assertTarballValid("artifact.tar", [
-            "lib/",
-            "lib/index.js",
-            "package.json",
-        ])
-    })
-
-    await test("cname present and allowlisted, repo mismatch", async() => {
-        await assertFail(() => packGitHubPages(p("./package-with-cname"), "MithrilJS/not-infra"))
-        await assertTarballMissing("artifact.tar")
-    })
-
-    await test("cname present yet not allowlisted, repo mismatch", async() => {
-        await assertFail(() => packGitHubPages(p("./package-wrong-cname"), "MithrilJS/not-infra"))
-        await assertTarballMissing("artifact.tar")
-    })
-
-    await test("cname missing, repo mismatch", async() => {
-        await assertFail(() => packGitHubPages(p("./package-no-cname"), "MithrilJS/not-infra"))
-        await assertTarballMissing("artifact.tar")
-    })
-})
-
 await suite("packNpm", async() => {
     await test("package name match, repo match", async() => {
         await packNpm(p("./package-no-cname"), "MithrilJS/infra")

lib/util.js

@@ -4,10 +4,8 @@ import * as fs from "node:fs/promises"
 import * as path from "node:path"
 import {fileURLToPath} from "node:url"
 import {inspect} from "node:util"
-import {once} from "node:events"
-import {spawn} from "node:child_process"
 
-import {Fail, captureToString, getTemp} from "../lib/util.js"
+import {Fail, getTemp} from "../lib/util.js"
 
 async function beforeEach() {
     const temp = await getTemp()
@@ -25,41 +23,12 @@ export function assertFail(fn) {
     return assert.rejects(fn, new Fail())
 }
 
-function unorderedEqual(a, b) {
-    return a.length === b.length &&
-        a.every((line) => b.includes(line)) &&
-        b.every((line) => a.includes(line))
-}
-
 let temp
 
 async function tempFile(name) {
     return path.resolve(temp ??= await getTemp(), name)
 }
 
-export async function assertTarballValid(name, expected) {
-    await assertTarballPresent(name)
-
-    const proc = spawn("tar", ["--list", "--file", await tempFile(name)], {
-        timeout: 5000,
-        stdio: ["inherit", "pipe", "pipe"],
-    })
-
-    const [[status, signal], stdout, stderr] = await Promise.all([
-        once(proc, "exit"),
-        captureToString(proc.stdout),
-        captureToString(proc.stderr),
-    ])
-
-    assert.equal(status, 0, `tar --list failed with status ${status}, signal ${signal}:\n${stderr}`)
-
-    const actual = stdout.trim().split(/\s*(?:\n|\r\n?)\s*/g)
-
-    if (!unorderedEqual(actual, expected)) {
-        throw new assert.AssertionError({message: "Tarball doesn't match.", expected, actual})
-    }
-}
-
 async function checkExists(file) {
     try {
         await fs.access(file)