Rust 2026 经验谈 - 从零到发布 CI/CD 全链路

1
name: CI
2

3
on:
4
  push:
5
    branches: [main]
6
  pull_request:
7
    branches: [main]
8

9
env:
10
  CARGO_TERM_COLOR: always
11

12
jobs:
13
  check:
14
    name: Check
15
    runs-on: ubuntu-latest
16
    steps:
17
      - uses: actions/checkout@v4
18
      - uses: dtolnay/rust-toolchain@stable
19
      - uses: Swatinem/rust-cache@v2
20
      - run: cargo check --workspace
21

22
  test:
23
    name: Test
24
    runs-on: ubuntu-latest
25
    steps:
26
      - uses: actions/checkout@v4
27
      - uses: dtolnay/rust-toolchain@stable
28
      - uses: Swatinem/rust-cache@v2
29
      - run: cargo install cargo-nextest --locked
30
      - run: cargo nextest run --workspace
31

32
  clippy:
33
    name: Clippy
34
    runs-on: ubuntu-latest
35
    steps:
36
      - uses: actions/checkout@v4
37
      - uses: dtolnay/rust-toolchain@stable
38
        with:
39
          components: clippy
40
      - uses: Swatinem/rust-cache@v2
41
      - run: cargo clippy --workspace -- -D warnings
42

43
  fmt:
44
    name: Formatting
45
    runs-on: ubuntu-latest
46
    steps:
47
      - uses: actions/checkout@v4
48
      - uses: dtolnay/rust-toolchain@stable
49
        with:
50
          components: rustfmt
51
      - run: cargo fmt --all -- --check
52

53
  docs:
54
    name: Docs
55
    runs-on: ubuntu-latest
56
    steps:
57
      - uses: actions/checkout@v4
58
      - uses: dtolnay/rust-toolchain@stable
59
      - uses: Swatinem/rust-cache@v2
60
      - run: cargo doc --workspace --no-deps
61
        env:
62
          RUSTDOCFLAGS: -D warnings

1
  test-matrix:
2
    name: Test (${{ matrix.os }}, ${{ matrix.rust }})
3
    runs-on: ${{ matrix.os }}
4
    strategy:
5
      fail-fast: false  # 一个失败不影响其他
6
      matrix:
7
        os: [ubuntu-latest, macos-latest, windows-latest]
8
        rust: [stable, beta]
9
        exclude:
10
          - os: windows-latest
11
            rust: beta  # 排除 Windows beta，减少 CI 时间
12

13
    steps:
14
      - uses: actions/checkout@v4
15
      - uses: dtolnay/rust-toolchain@master
16
        with:
17
          toolchain: ${{ matrix.rust }}
18
      - uses: Swatinem/rust-cache@v2
19
        with:
20
          key: ${{ matrix.os }}-${{ matrix.rust }}
21
      - run: cargo test --workspace

1
[changelog]
2
header = """# Changelog\n"""
3
body = """
4
{% if version %}## {{ version }} ({{ date | date(format="%Y-%m-%d") }}){% else %}## Unreleased{% endif %}
5
{% for group in commits | group_by(attribute="group") %}
6
### {{ group.key | capitalize }}
7
{% for commit in group.commits %}
8
- {{ commit.message | upper_first }}{% endfor %}
9
{% endfor %}\n
10
"""
11

12
[git]
13
conventional_commits = true
14
filter_unconventional = true
15
commit_parsers = [
16
  { message = "^feat", group = "Features" },
17
  { message = "^fix", group = "Bug Fixes" },
18
  { message = "^doc", group = "Documentation" },
19
  { message = "^perf", group = "Performance" },
20
  { message = "^refactor", group = "Refactor" },
21
  { message = "^chore", skip = true },
22
]

1
[package]
2
name = "my-crate"
3
version = "0.6.0"
4
edition = "2024"
5
description = "A concise description of what this crate does"
6
license = "MIT OR Apache-2.0"  # Rust 社区标准双许可
7
repository = "https://github.com/user/my-crate"
8
homepage = "https://user.github.io/my-crate"
9
documentation = "https://docs.rs/my-crate"  # 通常自动生成，无需显式设置
10
keywords = ["async", "stream", "backpressure"]
11
categories = ["asynchronous", "network-programming"]
12
rust-version = "1.85.0"
13
include = [          # 仅包含必要文件，减小 crate 体积
14
    "src/**/*.rs",
15
    "Cargo.toml",
16
    "README.md",
17
    "LICENSE-*",
18
]

1
name: Release
2

3
on:
4
  push:
5
    tags: ['v*']
6

7
jobs:
8
  publish:
9
    name: Publish to crates.io
10
    runs-on: ubuntu-latest
11
    environment: release  # GitHub Environment，保护 secrets
12
    steps:
13
      - uses: actions/checkout@v4
14
      - uses: dtolnay/rust-toolchain@stable
15
      - name: Publish
16
        run: cargo publish
17
        env:
18
          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}