feat: build and publish images (#124)

.github/workflows/e2e.yaml

@@ -1,4 +1,5 @@
-name: e2e
+name: End-to-end tests
+
 on:
   pull_request:
 
@@ -9,10 +10,10 @@ jobs:
     container: cypress/browsers:node18.12.0-chrome107
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
 
@@ -32,17 +33,17 @@ jobs:
         name: Setup pnpm cache
         with:
           path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-v2-${{ hashFiles('**/pnpm-lock.yaml') }}
+          key: ${{ runner.os }}-pnpm-store-v1-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            ${{ runner.os }}-pnpm-store-v2-
+            ${{ runner.os }}-pnpm-store-v1-
 
       - uses: actions/cache@v3
         name: Setup Cypress cache
         with:
           path: /github/home/.cache/Cypress
-          key: ${{ runner.os }}-cypress-v1-${{ hashFiles('**/pnpm-lock.yaml') }}
+          key: ${{ runner.os }}-cypress-v2-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            ${{ runner.os }}-cypress-v1-
+            ${{ runner.os }}-cypress-v2-
 
       - name: Install dependencies
         run: pnpm install

.github/workflows/data-dev.yaml → .github/workflows/images.yaml

@@ -1,49 +1,58 @@
-name: Publish data-dev Docker image
+name: Publish images
 
 on:
   push:
-    branches:
-      - main
-
-env:
-  REGISTRY: ghcr.io
-  IMAGE_NAME: pi-base/data-dev
+    tags:
+      - 'v*'
 
 jobs:
-  build-and-push-image:
+  build:
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        image:
+          - compile
+          - data-dev
+
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: pi-base/${{ matrix.image }}
+
     permissions:
       contents: read
       packages: write
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Lint Dockerfile
+      - name: Lint Dockerfiles
         uses: hadolint/[email protected]
         with:
-          dockerfile: images/data-dev/Dockerfile
+          dockerfile: images/${{ matrix.image }}/Dockerfile
 
-      - name: Log in to the Container registry
+      - name: Log in to the container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for Docker
+      - name: Extract metadata
         id: meta
         uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
         with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: ${{ env.REGISTRY }}/pi-base/${{ matrix.image }}
           tags: |
+            type=semver,pattern={{version}}
             type=sha
 
-      - name: Build and push Docker image
+      - name: Build and push
         uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
         with:
           context: .
-          file: images/data-dev/Dockerfile
+          file: images/${{ matrix.image }}/Dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/test.yaml

@@ -1,4 +1,5 @@
-name: test
+name: Unit tests
+
 on:
   push:
 
@@ -7,10 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
 

images/compile/Dockerfile

@@ -0,0 +1,27 @@
+# See https://pnpm.io/docker
+FROM node:18-slim AS base
+
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+
+RUN corepack enable
+
+VOLUME /data
+
+COPY . /app
+WORKDIR /app
+
+FROM base AS prod-deps
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --frozen-lockfile
+
+FROM base AS build
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
+    pnpm install --frozen-lockfile && \
+    pnpm run --filter core build && \
+    pnpm run --filter compile build && \
+    pnpm deploy --filter compile --prod /prod/compile
+
+FROM base
+COPY --from=build /prod/compile /app
+
+ENTRYPOINT ["node", "/app/dist/esm/main.js"]

packages/compile/package.json

@@ -31,7 +31,6 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@actions/core": "^1.10.0",
     "@pi-base/core": "workspace:*",
     "chalk": "^5.2.0",
     "chokidar": "^3.5.3",

packages/compile/src/main.test.ts

@@ -5,18 +5,20 @@ import { join } from 'node:path'
 
 const main = join(__dirname, '..', 'src', 'main.ts')
 const repo = join(__dirname, '..', 'test', 'repo')
-const out = join(repo, 'out.json')
+const out = 'out.json'
 
 async function run(dir: string) {
-  const { stdout, stderr, error, status } = spawnSync('tsx', [main], {
-    env: {
-      GITHUB_REF: 'refs/heads/test',
-      GITHUB_SHA: 'c74d99cf46f6ed23e742f2617e9908294b4a608b',
-      GITHUB_WORKSPACE: join(repo, dir),
-      INPUT_OUT: out,
-      PATH: process.env.PATH,
+  const { stdout, stderr, error, status } = spawnSync(
+    'tsx',
+    [main, join(repo, dir), out],
+    {
+      env: {
+        GITHUB_REF: 'refs/heads/test',
+        GITHUB_SHA: 'c74d99cf46f6ed23e742f2617e9908294b4a608b',
+        PATH: process.env.PATH,
+      },
     },
-  })
+  )
 
   if (error) {
     throw error
@@ -43,12 +45,10 @@ afterAll(cleanup)
 
 it('builds a bundle', async () => {
   const { output, error } = await run('valid')
-  expect(output).toContain(
-    `::debug::Compiling repo=${repo}/valid to out=${out}`,
-  )
+  expect(output).toContain(`::debug Compiling repo=${repo}/valid to out=`)
   expect(error).toBe(false)
 
-  const bundle = JSON.parse((await readFile(out)).toString())
+  const bundle = JSON.parse((await readFile(`${repo}/valid/${out}`)).toString())
 
   expect(bundle.properties.length).toEqual(3)
   expect(bundle.spaces.length).toEqual(2)

packages/compile/src/main.ts

@@ -1,44 +1,39 @@
-/**
- * Entry point for running as a Github action, with the local workspace
- * containing the data repository. Set GITHUB_WORKSPACE to use a different
- * data repository.
- */
-import * as core from '@actions/core'
 import * as fs from 'fs'
 import * as process from 'process'
 import { bundle as B } from '@pi-base/core'
 
 import load from './load.js'
 
-async function run(): Promise<void> {
-  const repo: string = process.env.GITHUB_WORKSPACE || '.'
-  const outpath: string = core.getInput('out')
-
-  core.debug(`Compiling repo=${repo} to out=${outpath}`)
+async function run(repo = '.', out = 'bundle.json'): Promise<void> {
+  log(`Compiling repo=${repo} to out=${out}`, 'debug')
 
   const { bundle, errors } = await load(repo)
 
   if (errors) {
     errors.forEach((messages, path) => {
       messages.forEach(message => {
-        error(path, message)
+        log(`file=${path}::${message}`, 'error')
       })
     })
   }
 
   if (errors || !bundle) {
-    core.setFailed('Compilation finished with errors')
-    return
+    log('Compilation finished with errors', 'error')
+    process.exit(1)
   }
 
-  fs.writeFileSync(outpath, JSON.stringify(B.serialize(bundle)))
+  fs.writeFileSync(`${repo}/${out}`, JSON.stringify(B.serialize(bundle)))
+}
+
+type Level = 'debug' | 'info' | 'error'
+
+function log(message: string, level: Level = 'info') {
+  console.log(`::${level} ${message}`)
 }
 
-function error(file: string, message: string) {
-  console.log(`::error file=${file}::${message}`)
+function fail(message: string) {
+  log(message, 'error')
+  process.exit(1)
 }
 
-run().catch(err => {
-  core.setFailed(err.message)
-  core.error(err.message)
-})
+run(...process.argv.slice(2)).catch(err => fail(err.message))

packages/compile/test/repo/.gitignore

@@ -0,0 +1 @@
+*.json

packages/core/package.json

@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "debug": "^4.3.4",
-    "micromark-util-types": "^1.0.2",
+    "micromark-util-types": "1.0.2",
     "rehype-katex": "^6.0.3",
     "rehype-stringify": "^9.0.3",
     "remark": "^14.0.2",