build-ast-grep-cli.yml

# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: MIT
---
# This workflow is based on the `linux` job of
# https://github.com/ast-grep/ast-grep/blob/main/.github/workflows/pypi.yml
name: Build ast-grep-cli wheels (riscv64)

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version glob to (re)build; empty builds every version of docs/packages/ast-grep-cli.yaml not released yet'
        required: false
        default: ''
  pull_request:
    branches: [main]
    paths:
      - '.github/workflows/build-ast-grep-cli.yml'
      - 'docs/packages/ast-grep-cli.yaml'
  push:
    branches: [main]
    paths:
      - '.github/workflows/build-ast-grep-cli.yml'
      - 'docs/packages/ast-grep-cli.yaml'

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read  # to fetch code (actions/checkout)

jobs:
  setup:
    uses: $/.github/workflows/_setup.yml
    with:
      package: ast-grep-cli
      version: ${{ inputs.version }}

  build_wheel:
    needs: [setup]
    if: needs.setup.outputs.versions != '[]'
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    name: Build ast-grep-cli ${{ matrix.version }} manylinux_riscv64
    runs-on: ubuntu-24.04-riscv
    timeout-minutes: 360

    env:
      AST_GREP_CLI_VERSION: ${{ matrix.version }}

    steps:
      - name: Checkout ast-grep v${{ env.AST_GREP_CLI_VERSION }}
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          repository: ast-grep/ast-grep
          ref: ${{ env.AST_GREP_CLI_VERSION }}
          persist-credentials: false

      # `[tool.maturin] bindings = "bin"`, manifest-path = crates/cli/Cargo.toml:
      # the wheel is one compiled executable (actually two: ast-grep and its sg
      # alias) with no ABI tag, so a single native build covers every interpreter.
      - name: Build wheel
        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b  # v1.51.0
        with:
          command: build
          target: riscv64gc-unknown-linux-gnu
          args: --release --locked --out dist
          manylinux: '2_39'
          before-script-linux: git config --global --add safe.directory "*"

      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: ast-grep-cli-${{ env.AST_GREP_CLI_VERSION }}-manylinux_riscv64
          path: dist/*.whl
          if-no-files-found: error

  test_wheel:
    name: Test ast-grep-cli ${{ matrix.version }} on Python ${{ matrix.python-version }}
    needs: [setup, build_wheel]
    if: needs.setup.outputs.versions != '[]'
    runs-on: ubuntu-24.04-riscv
    timeout-minutes: 30
    env:
      AST_GREP_CLI_VERSION: ${{ matrix.version }}
      # Without this uv would reuse the runner image's system CPython for 3.12
      # and download a standalone build for the others.
      UV_PYTHON_PREFERENCE: only-managed
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
        # This repo's default interpreter matrix (gotcha in workflow-anatomy.md);
        # the wheel is interpreter-agnostic (bindings = "bin"), so every
        # interpreter -- including free-threaded -- exercises the same binary.
        python-version: ['3.12', '3.13', '3.14', '3.14t']

    steps:
      - name: Download wheel
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: ast-grep-cli-${{ env.AST_GREP_CLI_VERSION }}-manylinux_riscv64

      - name: Install Python
        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d  # v10.0.1
        with:
          python-version: ${{ matrix.python-version }}
          activate-environment: true
          enable-cache: false

      - name: Install wheel
        run: uv pip install --reinstall --no-index --find-links . ast-grep-cli

      # No wheel-level test suite ships in the sdist (gotcha 187): crates/cli's
      # tests/*.rs are Rust integration tests run by upstream's own `cargo test`,
      # never packaged. Mirror upstream's own README search/rewrite example
      # instead of settling for a bare --version check; `sg` is a thin launcher
      # that execs `ast-grep` off PATH (crates/cli/src/bin/alias.rs), so it only
      # proves anything once both console scripts are actually installed.
      - name: Test wheel
        run: |
          set -euo pipefail
          ast-grep --version
          ast-grep --help >/dev/null
          sg --version

          work=$(mktemp -d)
          cat > "$work/a.js" <<'JS'
          console.log(123)
          alert(1)
          JS

          # $A is ast-grep's own pattern metavariable syntax, not a shell var.
          # shellcheck disable=SC2016
          ast-grep -p 'console.log($A)' "$work/a.js" | grep -q 'console.log(123)'

          # shellcheck disable=SC2016
          ast-grep -p 'alert($A)' -r 'alert(456)' -U "$work/a.js"
          grep -q 'alert(456)' "$work/a.js"

          ! ast-grep -p 'this-pattern-matches-nothing' "$work/a.js"

  publish:
    name: Publish ast-grep-cli ${{ matrix.version }}
    needs: [setup, build_wheel, test_wheel]
    if: needs.setup.outputs.versions != '[]'
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    permissions:
      contents: write
      pull-requests: write
    uses: $/.github/workflows/_publish-wheel.yml
    with:
      artifact-pattern: ast-grep-cli-${{ matrix.version }}-manylinux_riscv64