ci.yml

# Copyright 2024 Dotanuki Labs
# SPDX-License-Identifier: MIT

name: CI

on:
  pull_request:
  push:
    branches:
      - main

jobs:
  check-docs:
    runs-on: ubuntu-24.04
    steps:
      - name: Project Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Check typos on source files
        uses: dotanuki-labs/github-actions/quality/typos@main

      - name: Lint Markdown files
        uses: dotanuki-labs/github-actions/quality/markdown@main

      - name: Check MIT license on source files
        uses: dotanuki-labs/github-actions/foss/check-licenses@main
        with:
          file-patterns: '*.sh,*.rs,*.yml'
          license: 'mit'

      - name: Build documentation assets
        uses: dotanuki-labs/github-actions/foss/prepare-ghpages@main

  lint:
    runs-on: ubuntu-24.04
    needs: check-docs

    steps:
      - name: Project Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Lint Bash scripts
        uses: dotanuki-labs/github-actions/quality/bash@main

      - name: Lint project
        run: ./krabby.sh lint

  tests:
    runs-on: ubuntu-24.04
    needs: check-docs

    steps:
      - name: Project Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Setup CI
        uses: ./.github/actions/setup-rust

      - name: Run Rust tests
        run: ./krabby.sh tests

  build:
    needs: check-docs
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ 'ubuntu-22.04', 'macos-14' ]

    steps:
      - name: Project Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Setup CI
        uses: ./.github/actions/setup-rust

      - name: Cross-compilation against some targets
        run: ./krabby.sh assemble

      - name: Archive binaries
        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
        with:
          name: gwv-binaries-${{ runner.os }}
          path: artifacts

  security:
    runs-on: ubuntu-24.04
    needs: [lint, tests, build]

    steps:
      - name: Project Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Check supply-chain issues
        run: ./krabby.sh security

      - name: Generate SBOM
        run: ./krabby.sh sbom

      - name: Archive SBOM
        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
        with:
          name: sbom-${{ github.sha }}.json
          path: gwv.cdx.json