click-rs 1.0.2

A Rust port of Python's Click library for creating command-line interfaces
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

name: release

on:
  push:
    tags:
      - "v*"

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - name: Cache cargo
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
      - name: Tests
        env:
          CARGO_INCREMENTAL: "0"
        run: cargo test --all-features

  parity:
    runs-on: ubuntu-latest
    # Parity vs Python is a dev/PR quality check, not a release gate (and the harness
    # references the pre-rename `click` package). Non-blocking so releases aren't gated on it.
    continue-on-error: true
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Install Python dependencies
        run: python3 -m pip install --upgrade pip && python3 -m pip install -r tests/parity/requirements.txt
      - name: Parity tests
        env:
          CARGO_INCREMENTAL: "0"
        run: |
          bash tests/parity/run_parity.sh phase1
          bash tests/parity/run_parity.sh phase2
          bash tests/parity/run_parity.sh phase3
          bash tests/parity/run_parity.sh phase4
          bash tests/parity/run_parity.sh phase5
          bash tests/parity/run_parity.sh phase6

  package:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - name: Package (dry run)
        env:
          CARGO_INCREMENTAL: "0"
        run: cargo package

  publish:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    needs: [test, package]
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - name: Read crate version
        id: crate_version
        run: |
          set -euo pipefail
          version=$(cargo metadata --no-deps --format-version 1 | \
            python3 -c "import json,sys; pkgs=json.load(sys.stdin)['packages']; print(next(p['version'] for p in pkgs if p['name']=='click-rs'))")
          echo "version=$version" >> "$GITHUB_OUTPUT"
      - name: Check if version exists on crates.io
        id: version_check
        run: |
          set -euo pipefail
          version="${{ steps.crate_version.outputs.version }}"
          if curl -sfL -A "release-workflow (https://github.com/mrsaraiva)" "https://crates.io/api/v1/crates/click-rs/${version}"; then
            echo "exists=true" >> "$GITHUB_OUTPUT"
          else
            echo "exists=false" >> "$GITHUB_OUTPUT"
          fi
      - name: Skip publish (version exists)
        if: steps.version_check.outputs.exists == 'true'
        run: echo "crate version already published; skipping cargo publish"
      - name: Authenticate with crates.io
        id: auth
        uses: rust-lang/crates-io-auth-action@v1
        if: steps.version_check.outputs.exists != 'true'
      # NOTE: click-derive must already be published to crates.io (it is a dependency of
      # click-rs). Publish it once manually, then this workflow publishes click-rs on tags.
      - name: Publish to crates.io
        env:
          CARGO_INCREMENTAL: "0"
          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
        run: cargo publish -p click-rs --locked
        if: steps.version_check.outputs.exists != 'true'

  create-release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    needs: [test, package, publish]
    steps:
      - uses: actions/checkout@v4
      - name: Create GitHub Release
        uses: softprops/action-gh-release@v2
        with:
          generate_release_notes: true