mirror of
https://github.com/rust-lang/book.git
synced 2026-05-17 16:40:47 -04:00
9e2673a008
- Create an `mdbook_trpl` library package which hosts shared concerns for the packages, e.g. error and config handling. - Move `mdbook-trpl-note` and `mdbook-trpl-listing` into the new shared package, with binaries at `src/bin/(note|listing)/main.rs` and the existing libraries at `src/note/mod.rs` and `src/listing/mod.rs` with their associated tests. - Extract their actual shared pieces into the crate root. - Update `tools/nostarch.sh` to build all the bins in `mdbook_trpl` at one time. At the moment, this doesn't do a lot except trim down the number of packages in the repository, but it sets things up nicely to support more preprocessors (which I am going to add shortly).
105 lines
3.3 KiB
YAML
105 lines
3.3 KiB
YAML
name: CI
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
|
test:
|
|
name: Run tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Update rustup
|
|
run: rustup self update
|
|
- name: Install Rust
|
|
run: |
|
|
rustup set profile minimal
|
|
rustup toolchain install 1.82 -c rust-docs
|
|
rustup default 1.82
|
|
- name: Install mdbook
|
|
run: |
|
|
mkdir bin
|
|
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.21/mdbook-v0.4.21-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
|
|
echo "$(pwd)/bin" >> "${GITHUB_PATH}"
|
|
- name: Report versions
|
|
run: |
|
|
rustup --version
|
|
rustc -Vv
|
|
mdbook --version
|
|
|
|
# mdBook does not currently have particularly good support for “external”
|
|
# crates. To make the test suite work correctly with `trpl`, we must first
|
|
# build `trpl` itself (`mdbook` will not do it), and then explicitly pass
|
|
# its `deps` path as a library search path for `mdbook test`. That will make
|
|
# sure all the crates can be resolved when running the tests.
|
|
- name: Build `trpl` crate
|
|
run: |
|
|
cd packages/trpl
|
|
cargo build
|
|
- name: Run tests
|
|
run:
|
|
mdbook test --library-path packages/trpl/target/debug/deps
|
|
package_tests:
|
|
name: Run package tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Update rustup
|
|
run: rustup self update
|
|
- name: Install Rust
|
|
run: |
|
|
rustup set profile minimal
|
|
rustup toolchain install 1.82 -c rust-docs
|
|
rustup default 1.82
|
|
- name: Run `tools` package tests
|
|
run: |
|
|
cargo test
|
|
- name: Run `mdbook-trpl` package tests
|
|
working-directory: packages/mdbook-trpl
|
|
run: |
|
|
cargo test
|
|
lint:
|
|
name: Run lints
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Update rustup
|
|
run: rustup self update
|
|
- name: Install Rust
|
|
run: |
|
|
rustup set profile minimal
|
|
rustup toolchain install nightly -c rust-docs
|
|
rustup override set nightly
|
|
- name: Install mdbook
|
|
run: |
|
|
mkdir bin
|
|
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.21/mdbook-v0.4.21-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
|
|
echo "$(pwd)/bin" >> "${GITHUB_PATH}"
|
|
- name: Install mdbook-trpl binaries
|
|
run: cargo install --path packages/mdbook-trpl
|
|
- name: Install aspell
|
|
run: sudo apt-get install aspell
|
|
- name: Install shellcheck
|
|
run: sudo apt-get install shellcheck
|
|
- name: Report versions
|
|
run: |
|
|
rustup --version
|
|
rustc -Vv
|
|
mdbook --version
|
|
aspell --version
|
|
shellcheck --version
|
|
- name: Shellcheck
|
|
run: find . -name '*.sh' -print0 | xargs -0 shellcheck
|
|
- name: Spellcheck
|
|
run: bash ci/spellcheck.sh list
|
|
- name: Lint for local file paths
|
|
run: |
|
|
mdbook build
|
|
cargo run --bin lfp src
|
|
- name: Validate references
|
|
run: bash ci/validate.sh
|
|
- name: Check for broken links
|
|
run: |
|
|
curl -sSLo linkcheck.sh \
|
|
https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
|
|
# Cannot use --all here because of the generated redirect pages aren't available.
|
|
sh linkcheck.sh book
|