backend documents mirrors examples crates #93
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: Generated readme check | |
on: | |
push: | |
branches: [ main ] | |
pull_request: | |
types: [ opened, edited ] | |
branches: [ main ] | |
paths: | |
- 'README.md' | |
- 'README.tpl' | |
- 'gpu-alloc/src/lib.rs' | |
env: | |
CARGO_TERM_COLOR: always | |
jobs: | |
readme: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Install cargo-readme | |
uses: actions-rs/[email protected] | |
with: | |
crate: cargo-readme | |
use-tool-cache: true | |
- name: Check that readme is up-to-date | |
run: 'cd gpu-alloc && [[ ! $(cargo readme --template ../README.tpl | diff - ../README.md) ]]' |