add docs directory, remove noise from primary readme.md #83
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: ci | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| format: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - run: cargo fmt --all -- --check | |
| ubuntu-latest-nightly: | |
| needs: [format] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo test --all-features -- --test-threads=1 | |
| macos-latest-stable: | |
| needs: [format] | |
| runs-on: macos-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo test --all-features -- --test-threads=1 | |
| macos-latest-nightly: | |
| needs: [format] | |
| runs-on: macos-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo test --all-features -- --test-threads=1 | |
| windows-latest-stable: | |
| needs: [format] | |
| runs-on: windows-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo test --all-features -- --test-threads=1 | |
| windows-latest-nightly: | |
| needs: [format] | |
| runs-on: windows-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo test --all-features -- --test-threads=1 | |
| update-coverage: | |
| needs: [format] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: llvm-tools-preview | |
| - uses: taiki-e/install-action@cargo-llvm-cov | |
| - run: cargo llvm-cov --all-features --lcov --output-path lcov.info -- --test-threads=1 | |
| - uses: coverallsapp/[email protected] | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| path-to-lcov: lcov.info | |
| lint-code: | |
| needs: [format] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy | |
| - run: cargo clippy -- -W clippy::pedantic | |
| lint-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: CHANGELOG.md | |
| uses: docker://avtodev/markdown-lint:v1.5 | |
| with: | |
| rules: '/lint/rules/changelog.js' | |
| config: '/lint/config/changelog.yml' | |
| args: './CHANGELOG.md' | |
| - name: README.md CONTRIBUTING.md CODE_OF_CONDUCT.md | |
| uses: docker://avtodev/markdown-lint:v1.5 | |
| with: | |
| args: './README.md ./CONTRIBUTING.md ./CODE_OF_CONDUCT.md' |