cargo-sync-rdme 0.5.1

Cargo subcommand to synchronize README with crate 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

name: CD

on:
  push:
    tags:
      - "v?[0-9]+.[0-9]+.[0-9]+"
    branches:
      - main
  pull_request:
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch }}

env:
  CARGO_TERM_COLOR: always

permissions: {}

jobs:
  build-release-assets:
    name: Build artifacts for ${{ matrix.job.target }}
    runs-on: ${{ matrix.job.os }}
    strategy:
      fail-fast: true
      matrix:
        rust: [stable]
        job:
          - os: ubuntu-latest
            target: x86_64-unknown-linux-gnu
          - os: ubuntu-24.04-arm
            target: aarch64-unknown-linux-gnu
          - os: ubuntu-latest
            target: i686-unknown-linux-gnu
          - os: macos-latest
            target: aarch64-apple-darwin
          - os: windows-latest
            target: x86_64-pc-windows-msvc
          - os: windows-11-arm
            target: aarch64-pc-windows-msvc
    steps:
      - uses: actions/checkout@v7
      - uses: dtolnay/rust-toolchain@v1
        with:
          toolchain: ${{ matrix.rust }}
      - uses: taiki-e/install-action@v2
        with:
          tool: cross
      - uses: Swatinem/rust-cache@v2
        with:
          key: ${{ matrix.job.target }}

      - name: Install modern bash on macOS
        if: startsWith(matrix.job.os, 'macos')
        run: |
          brew install bash
          echo "/opt/homebrew/bin" >> "$GITHUB_PATH"
        shell: bash

      - name: Build artifact
        run: ./scripts/build-dist --target "${{ matrix.job.target }}"
        shell: bash

      - name: Upload binaries as artifacts
        uses: actions/upload-artifact@v7
        with:
          name: artifact-${{ matrix.job.target }}
          path: target/dist/*

  release:
    name: Create GitHub release
    runs-on: ubuntu-latest
    needs:
      - build-release-assets
    permissions:
      contents: write
    if: ${{ startsWith(github.ref, 'refs/tags/') }}
    steps:
      - name: Download built artifacts
        uses: actions/download-artifact@v8
        with:
          pattern: artifact-*
          path: target/dist
          merge-multiple: true

      - name: Releasing assets
        uses: softprops/action-gh-release@v3
        with:
          files: target/dist/*
          generate_release_notes: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  cd-complete:
    needs:
      - build-release-assets
      - release
    runs-on: ubuntu-latest
    if: ${{ always() }}
    steps:
      - name: CD complete
        run: |
          if ${{ !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}; then
            echo "CD succeeded"
          else
            echo "CD failed"
            exit 1
          fi
        shell: bash