garrison 0.9.0

Garrison - 面向 Rust 生态的一站式身份认证鉴权框架
Documentation
# Copyright (c) 2026 Kirky.X🌠
# SPDX-License-Identifier: Apache-2.0

# PR 级公共 API 差异(v1.0 API 冻结门禁,report-only)。
#
# 设计:
# - 以 PR base commit 为基线、PR head 为当前,双 checkout 生成两份 rustdoc JSON;
# - 差异由 scripts/api_surface.py 输出结构化 JSON(logs/api-surface-diff.json);
# - 仅上传工件供评审,不设置 required check,不阻断合并。
name: API Surface Diff

on:
  pull_request:
    branches: [main]

permissions:
  contents: read

concurrency:
  group: api-surface-diff-${{ github.event.pull_request.number }}
  cancel-in-progress: true

jobs:
  api-surface-diff:
    name: Public API diff (report-only)
    runs-on: ubuntu-latest
    # report-only:任何失败都不作为合并门禁;真实构建失败仍会在日志中可见。
    continue-on-error: true
    timeout-minutes: 45
    # nightly 钉到具体日期而非滚动通道:rustdoc JSON 必须用 nightly(-Zunstable-options),
    # 而滚动 nightly 会随上游 rustc 变更漂移——2026-10-31 nightly 在编译依赖
    # sea-orm 2.0.4 时触发 E0391(async drop 查询环),导致本 job 成败随日期随机
    # (2026-10-29 nightly 实测通过)。钉日期即拿到可复现结果。
    # 升级 nightly 时改这里一处。
    env:
      TOOLCHAIN: nightly-2026-10-29
    steps:
      - name: Checkout PR head
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          path: pr
          persist-credentials: false

      - name: Checkout PR base
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ github.event.pull_request.base.sha }}
          path: base
          persist-credentials: false

      # 本 workflow 的 checkout 落在 pr/ 与 base/ 子目录,脚本从 pr/ 取
      - name: Setup Rust toolchain (nightly-2026-10-29)
        working-directory: pr
        run: bash scripts/setup_rust.sh "$TOOLCHAIN"
        shell: bash
      - name: Install protoc (sdforge build dep)
        uses: taiki-e/install-action@b80e2bb2635f28eb98b9fce1e2f0887e1535c6b2 # v2.90.0
        with:
          tool: protoc

      - name: Generate base public API
        working-directory: base
        run: |
          cargo "+${TOOLCHAIN}" rustdoc --features full --lib -- \
            -Zunstable-options --output-format json
          python3 ../pr/scripts/api_surface.py target/doc/garrison.json \
            > /tmp/api-surface.baseline.txt

      - name: Generate PR public API and diff
        working-directory: pr
        run: bash scripts/api_surface.sh --diff /tmp/api-surface.baseline.txt

      - name: Upload API diff artifacts
        if: always()
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: api-surface-diff
          path: |
            pr/logs/api-surface.txt
            pr/logs/api-surface-diff.json
          if-no-files-found: warn
          retention-days: 30