Upgrade the CI system (#74)

.github/actions/common-setup/action.yml

@@ -0,0 +1,51 @@
+name: "Common setup"
+description: "Apply the common setup steps for this codebase"
+inputs:
+  platformCacheKey:
+    description: "The key for the cache for the platform; if empty the caching will be disabled"
+    required: false
+    default: ""
+  modeCacheKey:
+    description: "The key for the cache for the mode"
+    required: false
+    default: ""
+  requiresRust:
+    description: "Requires rust to be installed"
+    required: false
+    default: "true"
+  isOnSelfHostedRunner:
+    description: "Enable if running on a self-hosted runner"
+    required: false
+    default: "false"
+  buildEnvScript:
+    description: "The script to run to bootstrap the given environment"
+    required: false
+    default: ""
+runs:
+  using: "composite"
+  steps:
+    - name: Cache
+      uses: Swatinem/rust-cache@v2
+      with:
+        key: ${{ inputs.modeCacheKey == '' && inputs.platformCacheKey || ''}}
+        shared-key: ${{ inputs.modeCacheKey != '' && format('{0}-{1}', inputs.platformCacheKey, inputs.modeCacheKey) || '' }}
+      if: ${{ inputs.platformCacheKey != '' && inputs.isOnSelfHostedRunner != 'true' && inputs.requiresRust == 'true' }}
+
+    - name: Install rust toolchain
+      shell: bash
+      run: rustup show
+      if: ${{ inputs.requiresRust == 'true' }}
+
+    - name: Prepare the build environment
+      uses: ./.github/actions/env
+      with:
+        script: ${{ inputs.buildEnvScript }}
+      if: ${{ inputs.buildEnvScript != 'skip' }}
+
+    - name: Print build environment info
+      shell: bash
+      run: |
+        set -x
+        cargo --version
+        cargo clippy --version
+        env

.github/actions/env/action.yml

@@ -1,16 +1,16 @@
-name: 'Prepare environment'
-description: 'Prepare the environment for the build/deployment/etc'
+name: "Prepare environment"
+description: "Prepare the environment for the build/deployment/etc"
 inputs:
   script:
-    description: 'The script to run to bootstrap the given environment'
+    description: "The script to run to bootstrap the given environment"
     required: false
 runs:
   using: "composite"
   steps:
-      - name: Prepare the build environment
-        run: ${{ inputs.script }}
-        shell: bash
+    - name: Prepare the build environment
+      run: ${{ inputs.script }}
+      shell: bash
 
-      - name: Set up Vistual Studio Command Prompt (Windows only)
-        uses: ilammy/msvc-dev-cmd@v1
-        if: runner.os == 'Windows'
+    - name: Set up Vistual Studio Command Prompt (Windows only)
+      uses: ilammy/msvc-dev-cmd@v1
+      if: runner.os == 'Windows'

.github/actions/plan/action.yml

@@ -1,25 +1,18 @@
-name: 'Plan'
-description: 'Plan the execution and output a build matrix'
+name: "Plan"
+description: "Plan the execution and output a build matrix"
 inputs:
   plan-name:
-    description: 'What plan to use'
+    description: "What plan to use"
     required: true
 outputs:
   matrix:
-    description: 'The build matrix generated from planning'
-    value: ${{ steps.set-matrix.outputs.matrix }}
+    description: "The build matrix generated from planning"
+    value: ${{ steps.plan.outputs.matrix }}
 runs:
   using: "composite"
   steps:
-    - name: Compute matrix
-      uses: actions/github-script@v6
-      id: set-matrix
-      env:
-        PLAN_NAME: ${{ inputs.plan-name }}
-        ACTION_PATH: ${{ github.action_path }}
+    - uses: MOZGIII/action-plan@v0.8.0
+      id: plan
       with:
-        script: |
-          const planners = require(`${process.env.ACTION_PATH}/plan.js`);
-          const planner = planners[process.env.PLAN_NAME];
-          const matrix = planner();
-          core.setOutput('matrix', matrix);
+        plan-file: ${{ github.action_path }}/plan.ts
+        plan: ${{ inputs.plan-name }}

.github/actions/plan/matrix.ts

@@ -0,0 +1,34 @@
+export const matrixItems = <T extends Record<string, any>>(
+  map: T
+): Array<T[keyof T]> => Object.values(map);
+
+export const matrixItemsFiltered = <T extends Record<string, any>>(
+  map: T,
+  predicate: <K extends keyof T>(item: T[K]) => boolean
+): Array<T[keyof T]> => matrixItems<T>(map).filter(predicate);
+
+export const evalMatrix = <Keys extends string>(
+  dimensions: Record<Keys, Array<any>>,
+  includes: Array<Record<Keys, any>>
+): Array<Record<Keys, any>> => {
+  const evalNext = (
+    allVariants: Array<Partial<Record<Keys, any>>>,
+    key: Keys,
+    values: Array<any>
+  ) =>
+    allVariants.flatMap((variant) =>
+      values.map((value) => ({ ...variant, [key]: value }))
+    );
+  const dimensionKeys = Object.keys(dimensions) as Array<
+    keyof typeof dimensions
+  >;
+  const evaluated = dimensionKeys.reduce(
+    (allVariants, dimensionKey) =>
+      evalNext(allVariants, dimensionKey, dimensions[dimensionKey]),
+    [{}] as Array<Partial<Record<Keys, any>>>
+  ) as Array<Record<Keys, any>>;
+  return [...evaluated, ...includes];
+};
+
+export const logMatrix = (matrix: any) =>
+  console.log(JSON.stringify(matrix, null, "  "));

.github/actions/plan/modes.ts

@@ -0,0 +1,86 @@
+export type Mode = {
+  name: string;
+  cargoCommand: string;
+  cargoArgs: string;
+  cargoCacheKey: string;
+  platformIndependent?: true;
+  needsEchoServer?: true;
+};
+
+export type Modes = Record<string, Mode>;
+
+export const code = {
+  clippy: {
+    name: "clippy",
+    cargoCommand: "clippy",
+    cargoArgs: "--workspace --all-targets -- -D warnings",
+    cargoCacheKey: "clippy",
+  },
+  clippy_wasm: {
+    name: "clippy (wasm)",
+    cargoCommand: "clippy",
+    cargoArgs:
+      "--workspace --target wasm32-unknown-unknown --all-targets -- -D warnings",
+    platformIndependent: true,
+    cargoCacheKey: "clippy-wasm",
+  },
+  test: {
+    name: "test",
+    cargoCommand: "test",
+    cargoArgs: "--workspace",
+    cargoCacheKey: "test",
+    needsEchoServer: true,
+  },
+  test_wasm: {
+    name: "test (wasm)",
+    cargoCommand: "test",
+    cargoArgs: "--workspace --target wasm32-unknown-unknown",
+    platformIndependent: true,
+    cargoCacheKey: "test-wasm",
+    needsEchoServer: true,
+  },
+  build: {
+    name: "build",
+    cargoCommand: "build",
+    cargoArgs: "--workspace",
+    cargoCacheKey: "build",
+  },
+  build_wasm: {
+    name: "build (wasm)",
+    cargoCommand: "build",
+    cargoArgs: "--workspace --target wasm32-unknown-unknown",
+    platformIndependent: true,
+    cargoCacheKey: "build-wasm",
+  },
+  fmt: {
+    name: "fmt",
+    cargoCommand: "fmt",
+    cargoArgs: "-- --check",
+    platformIndependent: true,
+    cargoCacheKey: "code",
+  },
+  docs: {
+    name: "doc",
+    cargoCommand: "doc",
+    cargoArgs: "--workspace --document-private-items",
+    platformIndependent: true,
+    cargoCacheKey: "doc",
+  },
+  docs_wasm: {
+    name: "doc (wasm)",
+    cargoCommand: "doc",
+    cargoArgs:
+      "--workspace --target wasm32-unknown-unknown --document-private-items",
+    platformIndependent: true,
+    cargoCacheKey: "doc-wasm",
+  },
+} satisfies Modes;
+
+export const build = {
+  build: {
+    name: "build",
+    cargoCommand: "build",
+    cargoArgs: "--workspace --release",
+    cargoCacheKey: "release-build",
+  },
+} satisfies Modes;