mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-11-05 21:28:48 +00:00
01d571fc9e
* remove contributing guidelines duplicate `docs/contributing.md` is now auto generated * Commit Contributing Guidelines * core `xtask` functionality * almost there * write panic * almost almost there * there. * remove empty descriptions * better contributing.md comment * Commit Contributing Guidelines * remove entries without descriptions --------- Co-authored-by: adamperkowski <adamperkowski@users.noreply.github.com>
57 lines
1.2 KiB
YAML
57 lines
1.2 KiB
YAML
name: XTasks
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- "xtask"
|
|
- "Cargo.toml"
|
|
- "Cargo.lock"
|
|
- ".cargo"
|
|
- "core/tabs"
|
|
push:
|
|
paths:
|
|
- "xtask"
|
|
- "Cargo.toml"
|
|
- "Cargo.lock"
|
|
- ".cargo"
|
|
- "core/tabs"
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
|
|
jobs:
|
|
docgen:
|
|
name: DocGen
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install Rust
|
|
uses: dtolnay/rust-toolchain@stable
|
|
|
|
- name: Cache Cargo registry
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: ~/.cargo/registry
|
|
key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
|
|
restore-keys: ${{ runner.os }}-cargo-registry-
|
|
|
|
- name: Cache Cargo index
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: ~/.cargo/git
|
|
key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
|
|
restore-keys: ${{ runner.os }}-cargo-index-
|
|
|
|
- name: Run cargo xtask docgen
|
|
run: cargo xtask docgen
|
|
|
|
- name: Check uncommitted documentation changes
|
|
run: |
|
|
git diff
|
|
git diff-files --quiet \
|
|
|| (echo "Run 'cargo xtask docgen' and push the changes" \
|
|
&& exit 1)
|