cli.yml

# Build CLI binaries and publish them to GitHub Releases.
name: cli

on:
  push:
    branches: [ 'rust-ci' ]

  pull_request:

  repository_dispatch:
    types: build

  workflow_dispatch:

  workflow_call:

concurrency:
  group: cli-${{ github.workflow }}-${{ github.ref_type }}-${{ github.event.pull_request.number || github.ref || github.run_id }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash -euo pipefail {0}

env:
  GITHUB_REPOSITORY_URL: ${{ github.server_url }}/${{ github.repository }}
  VERBOSE: 1



jobs:

  build-cli:
    name: "Build CLI (${{ matrix.arch }})"
    runs-on: ubuntu-24.04

    strategy:
      fail-fast: false
      matrix:
        arch:
          - aarch64-apple-darwin
          - aarch64-unknown-linux-gnu
          - aarch64-unknown-linux-musl
          - x86_64-apple-darwin
          - x86_64-pc-windows-gnu
          - x86_64-unknown-linux-gnu
          - x86_64-unknown-linux-musl

    steps:
      - name: "Set up Docker Buildx"
        uses: docker/setup-buildx-action@v3

      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Setup cache for Rust and Cargo"
        uses: actions/cache@v4
        with:
          path: |
            .cache/docker-${{ matrix.arch }}/cargo/registry/index/
            .cache/docker-${{ matrix.arch }}/cargo/registry/cache/
            .cache/docker-${{ matrix.arch }}/cargo/git/db/
          key: neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-${{ matrix.arch }}-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-${{ matrix.arch }}-${{ hashFiles('**/Cargo.lock') }}
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-${{ matrix.arch }}-
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-

      - name: "Login to Docker Hub"
        uses: docker/login-action@v3
        with:
          registry: docker.io
          username: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_USERNAME }}
          password: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_TOKEN }}

      - name: "Prepare .env file"
        run: |
          cp .env.example .env
          sed -i -e "s|OSXCROSS_URL=http://example.com/osxcross/osxcross.tar.xz|OSXCROSS_URL=${{ secrets.OSXCROSS_URL }}|g" .env

      - name: "Build docker image (${{ matrix.arch }})"
        run: |
          CROSS_COMPILE="${{ matrix.arch }}" ./dev/docker/run echo "Success"

      - name: "Build CLI (${{ matrix.arch }})"
        run: |
          CROSS_COMPILE="${{ matrix.arch }}" ./dev/docker/run ./dev/cross/build pangraph

      - name: "Upload build artifacts (${{ matrix.arch }})"
        uses: actions/upload-artifact@v4
        with:
          name: pangraph-${{ matrix.arch }}
          path: ./.out/*
          include-hidden-files: true



  run-unit-tests:
    name: "Run unit tests"
    runs-on: ubuntu-24.04

    steps:
      - name: "Set up Docker Buildx"
        uses: docker/setup-buildx-action@v3

      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Setup cache for Rust and Cargo"
        uses: actions/cache@v4
        with:
          path: |
            .cache/docker-native/cargo/registry/index/
            .cache/docker-native/cargo/registry/cache/
            .cache/docker-native/cargo/git/db/
          key: neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-${{ hashFiles('**/Cargo.lock') }}
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-

      - name: "Login to Docker Hub"
        uses: docker/login-action@v3
        with:
          registry: docker.io
          username: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_USERNAME }}
          password: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_TOKEN }}

      - name: "Prepare .env file"
        run: |
          cp .env.example .env
          sed -i -e "s|OSXCROSS_URL=http://example.com/osxcross/osxcross.tar.xz|OSXCROSS_URL=${{ secrets.OSXCROSS_URL }}|g" .env

      - name: "Build docker image"
        run: |
          ./dev/docker/run echo "Success"

      - name: "Run unit tests"
        run: |
          ./dev/docker/run ./dev/dev test



  run-lints:
    name: "Run lints"
    runs-on: ubuntu-24.04

    steps:
      - name: "Set up Docker Buildx"
        uses: docker/setup-buildx-action@v3

      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Setup cache for Rust and Cargo"
        uses: actions/cache@v4
        with:
          path: |
            .cache/docker-native/cargo/registry/index/
            .cache/docker-native/cargo/registry/cache/
            .cache/docker-native/cargo/git/db/
          key: neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-${{ hashFiles('**/Cargo.lock') }}
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-native-
            neherlab-pangraph-cli-cache-v1-cargo-${{ runner.os }}-

      - name: "Login to Docker Hub"
        uses: docker/login-action@v3
        with:
          registry: docker.io
          username: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_USERNAME }}
          password: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_TOKEN }}

      - name: "Prepare .env file"
        run: |
          cp .env.example .env
          sed -i -e "s|OSXCROSS_URL=http://example.com/osxcross/osxcross.tar.xz|OSXCROSS_URL=${{ secrets.OSXCROSS_URL }}|g" .env

      - name: "Build docker image"
        run: |
          ./dev/docker/run echo "Success"

      - name: "Run lints"
        run: |
          ./dev/docker/run ./dev/dev lint



  run-compat-tests-x86_64-unknown-linux-gnu:
    name: "Compat test (x86_64-unknown-linux-gnu)"
    needs: [ build-cli ]
    runs-on: ubuntu-24.04

    steps:
      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Test Linux distros compatibility"
        run: |
          chmod +x ./.out/pangraph-x86_64-unknown-linux-gnu
          ./dev/test-linux-distros-gnu ./.out/pangraph-x86_64-unknown-linux-gnu --help

  run-compat-tests-x86_64-unknown-linux-musl:
    name: "Compat test (x86_64-unknown-linux-musl)"
    needs: [ build-cli ]
    runs-on: ubuntu-24.04

    steps:
      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Test Linux distros compatibility"
        run: |
          chmod +x ./.out/pangraph-x86_64-unknown-linux-musl
          ./dev/test-linux-distros-musl ./.out/pangraph-x86_64-unknown-linux-musl --help

  run-compat-tests-x86_64-apple-darwin:
    name: "Compat test (x86_64-apple-darwin)"
    needs: [ build-cli ]
    runs-on: macos-13

    steps:
      - name: "Show system info"
        run: |
          set -x
          uname -a || true
          sw_vers || true
          system_profiler SPSoftwareDataType SPHardwareDataType || true

      - name: "Check CPU Architecture"
        run: |
          arch="$(uname -m)"
          if [[ "$arch" != "x86_64" ]]; then
            echo "We hope to get x86_64 macOS instance for this job, to test whether our code still runs on Intel Macs. But we got '${arch}'. There isn't much point in testing this on non-x86_64 machine. From here you could either find a way to get an x86_64 macOS runner, or delete the test."
            exit 1
          fi

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Run compat test (x86_64-apple-darwin, native)"
        run: |
          chmod +x ./.out/*
          ./.out/pangraph-x86_64-apple-darwin --help

  run-compat-tests-aarch64-apple-darwin:
    name: "Compat test (aarch64-apple-darwin)"
    needs: [ build-cli ]
    runs-on: macos-latest

    steps:
      - name: "Show system info"
        run: |
          set -x
          uname -a || true
          sw_vers || true
          system_profiler SPSoftwareDataType SPHardwareDataType || true

      - name: "Check CPU Architecture"
        run: |
          arch="$(uname -m)"
          if [[ "$arch" != "arm64" ]]; then
            echo "This test requires arm64 machine, but got ${arch}"
            exit 1
          fi

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Run compat test (aarch64-apple-darwin, native)"
        run: |
          chmod +x ./.out/*
          ./.out/pangraph-aarch64-apple-darwin --help


  run-compat-tests-x86_64-pc-windows-gnu:
    name: "Compat test (x86_64-pc-windows-gnu)"
    needs: [ build-cli ]
    runs-on: windows-2019

    steps:
      - name: "Show system info"
        shell: powershell
        run: |
          $ErrorActionPreference = 'Stop'
          Set-PSDebug -Trace 1
          Write-Output "Architecture: $env:PROCESSOR_ARCHITECTURE"
          Write-Output "Windows Version:"
          systeminfo | Select-String "OS Name", "OS Version"
          Get-WmiObject Win32_Processor | Select-Object Name, NumberOfCores, NumberOfLogicalProcessors | Format-Table -AutoSize

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Run compat test (x86_64-pc-windows-gnu)"
        shell: powershell
        run: |
          .\.out\pangraph-x86_64-pc-windows-gnu --help


  check-cli-docs:
    name: "Check that autogenerated CLI documentation is up-to-date"
    needs: [ build-cli ]
    runs-on: ubuntu-24.04

    steps:
      - name: "Checkout code"
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          submodules: true

      - name: "Download build artifacts"
        uses: actions/download-artifact@v4
        with:
          pattern: pangraph-*
          merge-multiple: true
          path: ".out"

      - name: "Re-generate CLI docs"
        run: |
          chmod +x ./.out/pangraph-x86_64-unknown-linux-gnu
          cd docs/
          ./generate-reference-docs ../.out/pangraph-x86_64-unknown-linux-gnu docs/docs/reference.md

      - name: "Check that the git diff is clean"
        run: |
          git -c color.ui=always diff --exit-code 'docs/docs/reference.md' || (echo "Looks like command-line interface has changed, but the autogenerated CLI reference documentation at 'docs/docs/reference.md' is not up-to-date. Please build the fresh version of pangraph, then run 'cd docs && ./generate-reference-docs <path_to_pangraph> docs/docs/reference.md', then verify and commit changes to the file docs/docs/reference.md." >&2; exit 1)


#  publish-to-github-releases:
#    name: "Publish to GitHub Releases"
#    needs: [ build-cli, run-unit-tests, run-lints, run-smoke-tests, run-linux-distros-test ]
#    if: endsWith(github.ref, '/release-cli')
#    runs-on: ubuntu-24.04
#
#    steps:
#      - name: "Checkout code"
#        uses: actions/checkout@v4
#        with:
#          fetch-depth: 1
#          submodules: true
#
#      - name: "Download build artifacts"
#        uses: actions/download-artifact@v4
#        with:
#          pattern: pangraph-*
#          merge-multiple: true
#          path: ".out"
#
#      - name: "Install deploy dependencies"
#        run: |
#          mkdir -p "${HOME}/bin"
#          curl -fsSL "https://github.com/cli/cli/releases/download/v2.10.1/gh_2.10.1_linux_amd64.tar.gz" | tar xz -C "${HOME}/bin" --strip-components=2 gh_2.10.1_linux_amd64/bin/gh
#          curl -fsSL "https://github.com/TomWright/dasel/releases/download/v1.24.3/dasel_linux_amd64" -o "${HOME}/bin/dasel" && chmod +x "${HOME}/bin/dasel"
#          curl -fsSL "https://github.com/orhun/git-cliff/releases/download/v0.7.0/git-cliff-0.7.0-x86_64-unknown-linux-gnu.tar.gz" | tar -C "${HOME}/bin" --strip-components=1 -xz "git-cliff-0.7.0/git-cliff"
#          curl -fsSL "https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64" -o ${HOME}/bin/jq && chmod +x ${HOME}/bin/jq
#
#      - name: "Publish build artifacts to GitHub releases"
#        run: |
#          export PATH="${PATH}:${HOME}/bin"
#          export GITHUB_TOKEN="${{ secrets.NEHERLAB_BOT_GITHUB_TOKEN }}"
#          ./scripts/publish_github \
#            --artifacts_dir ".out" \
#            --repo "${{ github.repository }}" \
#            --git_sha "${{ github.sha }}"

#  publish-to-docker-hub:
#    name: "Publish to Docker Hub"
#    needs: [ build-cli, run-unit-tests, run-lints, run-smoke-tests, run-linux-distros-test ]
#    if: endsWith(github.ref, '/release-cli')
#    runs-on: ubuntu-24.04
#
#    steps:
#      - name: "Checkout code"
#        uses: actions/checkout@v4
#        with:
#          fetch-depth: 1
#          submodules: true
#
#      - name: "Download build artifacts"
#        uses: actions/download-artifact@v4
#        with:
#          pattern: pangraph-*
#          merge-multiple: true
#          path: ".out"
#
#      - name: "Install deploy dependencies"
#        run: |
#          mkdir -p "${HOME}/bin"
#          curl -fsSL "https://github.com/TomWright/dasel/releases/download/v1.24.3/dasel_linux_amd64" -o "${HOME}/bin/dasel" && chmod +x "${HOME}/bin/dasel"
#
#      - name: "Login to Docker Hub"
#        uses: docker/login-action@v3
#        with:
#          registry: docker.io
#          username: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_USERNAME }}
#          password: ${{ secrets.NEHERLAB_BOT_DOCKERHUB_TOKEN }}
#
#      - name: "Build and publish Docker container images to Docker Hub"
#        run: |
#          export PATH="${PATH}:${HOME}/bin"
#          chmod +x ./.out/*
#          ./scripts/publish_docker --push