generic-array/.github/workflows/CI.yml at master · fizyk20/generic-array · GitHub

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
name: Build

on: [push, pull_request]

env:
  CARGO_TERM_COLOR: always
  RUSTDOCFLAGS: "--cfg docsrs"

jobs:
  build_test:
    name: Build and Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@nightly

      - name: Install Miri
        run: |
          rustup toolchain install nightly --component miri
          cargo miri setup

      - name: Test with Miri
        run: cargo miri test --all-features

  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@nightly
        with:
          components: llvm-tools-preview

      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov

      # Runs on every push/PR so a coverage regression that fails to build is
      # caught early. `jq` is preinstalled on the ubuntu runners.
      - name: Measure coverage
        run: |
          cargo llvm-cov --all-features --json --summary-only > coverage.json
          COVERAGE=$(jq '.data[0].totals.lines.percent' coverage.json)
          COVERAGE=$(printf '%.1f' "$COVERAGE")
          echo "COVERAGE=$COVERAGE" >> "$GITHUB_ENV"
          echo "Line coverage: $COVERAGE%"

      # Only publish the badge from pushes to master. PRs (especially from forks)
      # cannot read GIST_SECRET, so this step is skipped there rather than failing.
      - name: Publish coverage badge
        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
        uses: schneegans/dynamic-badges-action@v1.8.0
        with:
          auth: ${{ secrets.GIST_SECRET }}
          gistID: 90a80c3c5ed11247c03a2012955f4f2e
          filename: generic-array-coverage.json
          label: coverage
          message: ${{ env.COVERAGE }}%
          valColorRange: ${{ env.COVERAGE }}
          minColorRange: 50
          maxColorRange: 95

  deploy_docs:
    name: Deploy documentation
    runs-on: ubuntu-latest
    needs: build_test
    if: github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@nightly

      - name: Build documentation
        run: cargo doc --features "serde zeroize const-default alloc hybrid-array-0_4 subtle arbitrary bytemuck bitvec as_slice"

      - name: Finalize documentation
        run: |
          echo "<meta http-equiv=\"refresh\" content=\"0; url=generic_array\">" > target/doc/index.html
          touch target/doc/.nojekyll

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: target/doc