build.yml

name: Build and Test the Material

# Runs CI on pushing tags and pulls, but not both. Since we have branch protection on, these are our only cases to handle.
on:
  push:
    tags:
      - "*"
  pull_request:

env:
  CARGO_TERM_COLOR: always # We want colors in our CI output
  CARGO_INCREMENTAL: 0 # Don't waste time writing out incremental build files
  CARGO_PROFILE_TEST_DEBUG: 0 # These are thrown away anyways, don't produce them

jobs:
  render-material:
    name: Render Material
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install tools
        uses: taiki-e/install-action@v2
        with:
          tool: mdbook@0.4.42,mdbook-graphviz@0.2.1

      - name: Add mdslides
        run: |
          curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrous-systems/mdslides/releases/download/v0.6.1/mdslides-installer.sh | sh

      - name: Add graphviz
        run: |
          sudo apt-get update -y && sudo apt-get install -y graphviz

      # A `minimal` profile saves a couple seconds from not downloading `clippy` or `rustdocs` and friends
      - name: Update Rust
        run: |
          rustup set profile minimal
          rustup update stable --no-self-update

      - name: Find slug name
        run: |
          slug=$(./describe.sh "${GITHUB_REF}")
          echo "Building with slug '${slug}'"
          echo "slug=${slug}" >> "${GITHUB_ENV}"

      - name: Execute
        run: |
          ./localbuild.sh render-material

      - name: Assemble Artifacts
        run: |
          echo "Making ./rust-training-${{ env.slug }}..."
          mkdir -p ./rust-training-${{ env.slug }}
          mv ./training-slides/slides ./rust-training-${{ env.slug }}/training-slides-presentation
          mv ./training-slides/book ./rust-training-${{ env.slug }}/training-slides-book
          cp -r ./example-code ./rust-training-${{ env.slug }}
          echo "Compressing ./rust-training-${{ env.slug }}.zip..."
          zip -r ./rust-training-${{ env.slug }}.zip ./rust-training-${{ env.slug }}

      - name: Upload Artifacts
        uses: actions/upload-artifact@v4
        if: ${{success()}}
        with:
          name: Material
          if-no-files-found: error
          path: |
            ./rust-training-*/

      - name: Create and Upload Release
        if: github.event_name == 'push' && startswith(github.ref, 'refs/tags/')
        id: create_release
        uses: ncipollo/release-action@v1
        with:
          artifacts: ./rust-training-${{ env.slug }}.zip

  test-cheatsheets:
    name: Test Cheatsheets
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: xtask

      - name: Execute
        run: |
          ./localbuild.sh test-cheatsheets

  ferrocene-qemu-aarch64v8a:
    name: Build qemu-aarch64v8a with Ferrocene
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Critical Up
        run: |
          curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrocene/criticalup/releases/download/v1.1.0/criticalup-installer.sh | sh

      - name: Execute
        env:
          CRITICALUP_TOKEN: ${{ secrets.CRITICALUP_TOKEN }}
        run: |
          ./localbuild.sh ferrocene-qemu-aarch64v8a

  ferrocene-qemu-aarch32v8r:
    name: Build qemu-aarch32v8r with Ferrocene
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Critical Up
        run: |
          curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrocene/criticalup/releases/download/v1.1.0/criticalup-installer.sh | sh

      - name: Execute
        env:
          CRITICALUP_TOKEN: ${{ secrets.CRITICALUP_TOKEN }}
        run: |
          ./localbuild.sh ferrocene-qemu-aarch32v8r

  ferrocene-qemu-thumbv7em:
    name: Build qemu-thumbv7em with Ferrocene
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Critical Up
        run: |
          curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrocene/criticalup/releases/download/v1.1.0/criticalup-installer.sh | sh

      - name: Execute
        env:
          CRITICALUP_TOKEN: ${{ secrets.CRITICALUP_TOKEN }}
        run: |
          ./localbuild.sh ferrocene-qemu-thumbv7em

  eg-native-ffi-use-c-in-rust:
    name: Build Example ffi-use-c-in-rust
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: rustup set profile minimal

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/native/ffi/use-c-in-rust

      - name: Execute
        run: |
          ./localbuild.sh eg-native-ffi-use-c-in-rust

  eg-native-ffi-use-rust-in-c:
    name: Build Example ffi-use-rust-in-c
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: rustup set profile minimal

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/native/ffi/use-rust-in-c

      - name: Execute
        run: |
          ./localbuild.sh eg-native-ffi-use-rust-in-c

  eg-native-stdout:
    name: Build Example native-stdout
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: rustup set profile minimal

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/native/stdout

      - name: Execute
        run: |
          ./localbuild.sh eg-native-stdout

  eg-nrf52-bsp-demo:
    name: Build Example nrf52-bsp-demo
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: |
          rustup set profile minimal
          rustup target add thumbv7em-none-eabihf

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/nrf52/bsp_demo

      - name: Execute
        run: |
          ./localbuild.sh eg-nrf52-bsp-demo

  eg-qemu-aarch64v8a:
    name: Build Example qemu-aarch64v8a
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: |
          rustup set profile minimal
          rustup target add aarch64-unknown-none
          rustup component add llvm-tools-preview
          rustup component add rust-src

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/qemu-aarch64v8a

      - name: Execute
        run: |
          ./localbuild.sh eg-qemu-aarch64v8a

  eg-qemu-aarch32v8r:
    name: Build Example qemu-aarch32v8r
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: |
          rustup set profile minimal
          rustup component add rust-src

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/qemu-aarch32v8r

      - name: Execute
        run: |
          ./localbuild.sh eg-qemu-aarch32v8r

  eg-qemu-thumbv7em:
    name: Build Example qemu-thumbv7em
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add Rust Targets and Tools
        run: |
          rustup set profile minimal
          rustup target add thumbv7em-none-eabihf

      - name: Set up cache
        uses: Swatinem/rust-cache@v2
        with:
          workspaces: example-code/qemu-thumbv7em

      - name: Execute
        run: |
          ./localbuild.sh eg-qemu-thumbv7em

  build-windows-examples:
    name: Build Example ffi-use-rust-in-c on Windows
    runs-on: windows-2022
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Add msbuild to PATH
        uses: microsoft/setup-msbuild@v2

      - name: Execute
        run: |
          cd example-code\native\ffi\use-rust-in-c\windows-example
          msbuild.exe windows-example.sln /p:Configuration=Debug
          .\x64\Debug\windows-example.exe
          msbuild.exe windows-example.sln /p:Configuration=Release
          .\x64\Release\windows-example.exe