Add plumbing to upload schemas to GitHub Pages every day (SchemaStore#4727)

Author: hyperupcall

.github/workflows/github-pages.yml

@@ -0,0 +1,43 @@
+name: 'Deploy to GitHub pages'
+
+on:
+  schedule:
+    # Every day at 20:30 UTC.
+    - cron: '30 20 * * *'
+  push:
+    branches: ['master']
+  workflow_dispatch:
+
+permissions:
+  contents: 'read'
+  pages: 'write'
+  id-token: 'write'
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  # Build job.
+  build:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: 'actions/checkout@v4'
+      - run: 'node ./cli.js build-website'
+      - uses: 'actions/configure-pages@v5'
+      - uses: 'actions/upload-pages-artifact@v3'
+        with:
+          path: './website'
+
+  # Deployment job.
+  deploy:
+    environment:
+      name: 'github-pages'
+      url: '${{ steps.deployment.outputs.page_url }}'
+    runs-on: 'ubuntu-latest'
+    needs: 'build'
+    steps:
+      - id: 'deployment'
+        uses: 'actions/deploy-pages@v4'

.gitignore

@@ -1,6 +1,7 @@
 # This ignore file is shared with Prettier. It seems .git/ must be ignored manually now.
 .git/
 
+website/
 # registry API folder
 src/api/registry/
 

cli.js

@@ -908,6 +908,34 @@ async function taskMaintenance() {
   // await printDowngradableSchemaVersions()
 }
 
+async function taskBuildWebsite() {
+  await fs.mkdir('./website', { recursive: true })
+  await Promise.all(
+    SchemasToBeTested.map((schemaName) => {
+      return fs
+        .copyFile(
+          path.join(SchemaDir, schemaName),
+          path.join('./website', schemaName),
+        )
+        .catch((err) => {
+          if (err.code !== 'EISDIR') throw err
+        })
+    }),
+  )
+  await Promise.all(
+    SchemasToBeTested.map((schemaName) => {
+      return fs
+        .copyFile(
+          path.join(SchemaDir, schemaName),
+          path.join('./website', path.parse(schemaName).name),
+        )
+        .catch((err) => {
+          if (err.code !== 'EISDIR') throw err
+        })
+    }),
+  )
+}
+
 async function assertFileSystemIsValid() {
   /**
    * Check that files exist only where files belong, and directories exist only
@@ -1858,6 +1886,7 @@ EXAMPLES:
     'check-remote': taskCheckRemote,
     report: taskReport,
     maintenance: taskMaintenance,
+    'build-website': taskBuildWebsite,
     'build-xregistry': taskBuildXRegistry,
     build: taskCheck, // Undocumented alias.
   }