mensa/.github/workflows/verify-readme.yml

38 lines
869 B
YAML

name: Verify Makefile
on:
push:
branches:
- main
paths:
- README.md
- README.tpl
- src/main.rs
- Cargo.toml
pull_request:
branches:
- main
paths:
- README.md
- README.tpl
- src/main.rs
- Cargo.toml
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true
profile: minimal
- uses: actions-rs/install@v0.1
with:
crate: cargo-readme
version: latest
use-tool-cache: true
- run: cargo readme --no-indent-headings --output README.md
# This will verify that cargo readme did not do anything
# If it did, the CI should fail, because the README is outdated
- run: git diff --exit-code