diff options
| author | Gokul Soumya | 2021-11-29 14:54:24 +0000 |
|---|---|---|
| committer | Blaž Hrastnik | 2021-12-08 01:23:50 +0000 |
| commit | 70c989e122e498705606da3beb4154564b9a14d2 (patch) | |
| tree | b72d32e82b27e935bdb0b023f00d2f0a3446db93 | |
| parent | a78b7894066b6ccf56c404b7543b45e2dfd99982 (diff) | |
Add github action to lint unmerged docs
| -rw-r--r-- | .github/workflows/build.yml | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 21629180..7f18da6a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -137,3 +137,51 @@ jobs: with: command: clippy args: -- -D warnings + + docs: + name: Docs + runs-on: ubuntu-latest + steps: + - name: Checkout sources + uses: actions/checkout@v2 + with: + submodules: true + + - name: Install stable toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + + - name: Cache cargo registry + uses: actions/cache@v2.1.6 + with: + path: ~/.cargo/registry + key: ${{ runner.os }}-v2-cargo-registry-${{ hashFiles('**/Cargo.lock') }} + + - name: Cache cargo index + uses: actions/cache@v2.1.6 + with: + path: ~/.cargo/git + key: ${{ runner.os }}-v2-cargo-index-${{ hashFiles('**/Cargo.lock') }} + + - name: Cache cargo target dir + uses: actions/cache@v2.1.6 + with: + path: target + key: ${{ runner.os }}-v2-cargo-build-target-${{ hashFiles('**/Cargo.lock') }} + + - name: Generate docs + uses: actions-rs/cargo@v1 + with: + command: xtask + args: docgen + + - name: Check uncommitted documentation changes + run: | + git diff + git diff-files --quiet \ + || (echo "Run 'cargo xtask docgen', commit the changes and push again" \ + && exit 1) + |