feat: add man pages and shell completions #79
Workflow file for this run
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: | |
push: | |
pull_request: | |
workflow_dispatch: | |
schedule: | |
- cron: '0 0 1 * *' # Monthly | |
jobs: | |
build: | |
strategy: | |
fail-fast: false | |
matrix: | |
rust: [stable, beta] | |
features: ['', dlopen] | |
name: ${{ matrix.rust }} - ${{ matrix.features }} | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
show-progress: false | |
- name: Install Rust | |
run: | | |
rustup set auto-self-update check-only | |
rustup toolchain install ${{ matrix.rust }} --profile minimal | |
- uses: Swatinem/rust-cache@v2 | |
- name: Build | |
run: cargo build --all --features=${{ matrix.features }} | |
- name: Set up XDG_RUNTIME_DIR | |
run: | | |
mkdir .runtime | |
echo "XDG_RUNTIME_DIR=$PWD/.runtime" >> $GITHUB_ENV | |
- name: Test | |
run: cargo test --all --features=${{ matrix.features }} | |
- name: Generate documentation | |
run: cargo doc --features=${{ matrix.features }} | |
- name: Copy documentation index | |
run: cp doc/index.html target/doc/ | |
- name: Deploy documentation | |
if: > | |
matrix.rust == 'stable' && | |
matrix.features == '' && | |
github.event_name == 'push' && | |
github.ref == 'refs/heads/master' | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./target/doc | |
clippy: | |
name: clippy | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
show-progress: false | |
- name: Install Rust | |
run: | | |
rustup set auto-self-update check-only | |
rustup toolchain install stable --profile minimal --component clippy | |
- uses: Swatinem/rust-cache@v2 | |
- name: Run clippy | |
run: cargo clippy --all --all-targets | |
rustfmt: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
show-progress: false | |
- name: Install Rust | |
run: | | |
rustup set auto-self-update check-only | |
rustup toolchain install nightly --profile minimal --component rustfmt | |
rustup override set nightly | |
- name: Run rustfmt | |
run: cargo fmt --all -- --check |