docs: 添加独立的文档页面,移除 README 中的相关描述 #117
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: Check | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
types: ['opened', 'reopened', 'synchronize', 'ready_for_review'] | |
concurrency: | |
# Allow only one workflow per any non-`main` branch. | |
group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.ref_name == 'main' && github.sha || 'anysha' }} | |
cancel-in-progress: true | |
env: | |
CARGO_TERM_COLOR: always | |
CARGO_INCREMENTAL: 0 | |
RUST_BACKTRACE: 1 | |
jobs: | |
tests: | |
name: Run Clippy and tests | |
runs-on: ubuntu-latest | |
if: ${{ github.event_name == 'push' || !github.event.pull_request.draft }} | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- run: rustup default nightly-2024-04-30 && rustup component add rustfmt clippy | |
- name: Cache dependencies | |
uses: swatinem/rust-cache@v2 | |
with: | |
save-if: ${{ github.ref == 'refs/heads/main' }} | |
- name: cargo fmt check | |
run: cargo fmt --check | |
- name: cargo clippy | |
run: cargo clippy | |
- name: cargo test | |
run: cargo test |