Skip to content

Remove src/doc from exclude list in Cargo.toml #12000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 21, 2023
Merged

Remove src/doc from exclude list in Cargo.toml #12000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff216eb
chore: make `server-check` a workspace member
weihanglo Apr 19, 2023
3b8d744
ci: run linkchekcer from target dir
weihanglo Apr 19, 2023
8966ab0
chore: remove `src/doc` from `exclude` list in Cargo.toml
weihanglo Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ jobs:
- run: rustup component add rust-docs
- run: ci/validate-man.sh
# This requires rustfmt, use stable.
- run: cd src/doc/semver-check && cargo +stable run
- name: Run semver-check
run: cargo +stable run -p semver-check
- run: |
mkdir mdbook
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.27/mdbook-v0.4.27-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
Expand All @@ -195,11 +196,11 @@ jobs:
env:
RUSTDOCFLAGS: -D warnings
- run: cd src/doc && mdbook build --dest-dir ../../target/doc
- run: |
cd src/doc
curl -sSLo linkcheck.sh \
https://github.com/raw/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
sh linkcheck.sh --all cargo
- name: Run linkchecker.sh
run: |
cd target
curl -sSLO https://github.com/raw/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
sh linkcheck.sh --all --path ../src/doc cargo

success:
permissions:
Expand Down
7 changes: 7 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 0 additions & 4 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ members = [
"benches/capture",
]
exclude = [
# For linkchecker (downloaded during CI) and semver-check
# TODO: Either move semver-check to crates/ folder,
# or make linkchecker run from a given directory.
"src/doc/",
"target/", # exclude bench testing
]

Expand Down
0 src/doc/semver-check/Cargo.toml → crates/semver-check/Cargo.toml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion src/doc/semver-check/src/main.rs → crates/semver-check/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const SEPARATOR: &str = "///////////////////////////////////////////////////////
fn doit() -> Result<(), Box<dyn Error>> {
let filename = std::env::args()
.nth(1)
.unwrap_or_else(|| "../src/reference/semver.md".to_string());
.unwrap_or_else(|| "src/doc/src/reference/semver.md".to_string());
let contents = fs::read_to_string(filename)?;
let mut lines = contents.lines().enumerate();

Expand Down