CI.yml

name: Rust

on:
    push:
        branches: [master]
        paths-ignore:
            - ".gitignore"
            - ".git-blame-ignore-revs"
    pull_request:
        branches: [master]
        paths-ignore:
            - ".gitignore"
            - ".git-blame-ignore-revs"

env:
    CARGO_TERM_COLOR: always

jobs:
    check:
        name: Check
        runs-on: ubuntu-latest
        env:
            RUSTFLAGS: -Dwarnings
        steps:
            - uses: actions/checkout@v2
              with:
                  submodules: true

            - name: Install Rust (stable)
              uses: actions-rs/toolchain@v1
              with:
                  profile: minimal
                  toolchain: stable
                  override: true

            - name: Cargo check
              uses: actions-rs/cargo@v1
              with:
                  command: check
                  args: --all-features

    test:
        name: Test
        runs-on: ${{ matrix.os }}
        needs: check
        strategy:
            fail-fast: false
            matrix:
                os: [ubuntu-latest]
                toolchain: [stable, beta, nightly, "1.60"]
                include:
                    - os: windows-latest
                      toolchain: nightly
                    - os: macos-latest
                      toolchain: nightly
        steps:
            - name: Checkout source code
              uses: actions/checkout@v2
              with:
                  submodules: true

            - name: Install ${{ matrix.toolchain }} toolchain
              uses: actions-rs/toolchain@v1
              with:
                  profile: minimal
                  toolchain: ${{ matrix.toolchain }}
                  override: true
                  components: rustfmt

            - name: Install cargo-hack
              uses: taiki-e/install-action@v1
              with:
                  tool: cargo-hack

            - name: Cargo test
              id: tests
              uses: alexschrod/action-rs-cargo@feat/stdout-stderr
              env:
                  RUST_BACKTRACE: 1
              with:
                  command: hack
                  args: --feature-powerset --keep-going test --message-format=json --no-fail-fast --workspace
                  stdout-file: tests.json

            - name: Cargo metadata
              id: metadata
              if: always()
              uses: alexschrod/action-rs-cargo@feat/stdout-stderr
              with:
                  command: metadata
                  args: --format-version 1
                  stdout-file: metadata.json

            - name: Create test annotations
              if: always()
              uses: alexschrod/cargo-test-annotations@master
              with:
                  metadata: "metadata.json"
                  tests: "tests.json"
                  token: ${{ secrets.GITHUB_TOKEN }}
                  name: cargo-test-annotations (${{ matrix.os }}, ${{ matrix.toolchain }})

    miri:
        name: Miri
        runs-on: ubuntu-latest
        needs: check
        continue-on-error: true
        steps:
            - name: Checkout source code
              uses: actions/checkout@v2
              with:
                  submodules: true

            - name: Install Rust
              uses: actions-rs/toolchain@v1
              with:
                  profile: minimal
                  toolchain: nightly
                  override: true
                  components: miri

            - name: Setup miri
              run: cargo miri setup

            - name: Run miri
              run: cargo miri test --all-features

    style:
        name: Check Style
        runs-on: ubuntu-latest
        needs: check
        steps:
            - uses: actions/checkout@v2
              with:
                  submodules: true

            - name: Install stable toolchain
              uses: actions-rs/toolchain@v1
              with:
                  profile: minimal
                  toolchain: stable
                  override: true
                  components: clippy, rustfmt

            - name: Run cargo fmt
              uses: actions-rs/cargo@v1
              with:
                  command: fmt
                  args: --all -- --check

            - name: Run cargo clippy
              uses: actions-rs/clippy-check@v1
              with:
                  token: ${{ secrets.GITHUB_TOKEN }}
                  args: --all-features

    coverage:
        name: Report coverage
        runs-on: ubuntu-latest
        needs: test
        if: github.event_name != 'pull_request'
        container:
            image: xd009642/tarpaulin:develop-nightly
            options: --security-opt seccomp=unconfined

        steps:
            - name: Checkout repository
              uses: actions/checkout@v2

            - name: Generate code coverage
              run: |
                  cargo +nightly tarpaulin --verbose --all-features --workspace --timeout 120 --out Xml

            - name: Upload coverage
              uses: codecov/codecov-action@v2
              with:
                  token: ${{ secrets.CODECOV_TOKEN }}
                  fail_ci_if_error: true

    docs:
        name: Documentation
        runs-on: ubuntu-latest
        needs: check
        if: github.event_name != 'pull_request'
        steps:
            - name: Checkout source code
              uses: actions/checkout@v2
              with:
                  persist-credentials: false

            - name: Install Rust
              uses: actions-rs/toolchain@v1
              with:
                  profile: minimal
                  toolchain: nightly
                  override: true

            - name: Build documentation
              uses: actions-rs/cargo@v1
              env:
                  RUSTDOCFLAGS: --cfg docsrs
              with:
                  command: doc
                  args: --verbose --no-deps --all-features --workspace

            - name: Finalize documentation
              run: |
                  #CRATE_NAME=$(echo '${{ github.repository }}' | tr '[:upper:]' '[:lower:]' | cut -f2 -d"/")
                  #echo "<meta http-equiv=\"refresh\" content=\"0; url=${CRATE_NAME/-/_}\">" > target/doc/index.html
                  echo "<meta http-equiv=\"refresh\" content=\"0; url=nombytes\">" > target/doc/index.html
                  touch target/doc/.nojekyll

            - name: Upload as artifact
              uses: actions/upload-artifact@v2
              with:
                  name: Documentation
                  path: target/doc

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