-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Filter linkcheck spurious failure #63927
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.
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
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
use clap::{crate_version}; | ||
use clap::crate_version; | ||
|
||
use std::env; | ||
use std::path::{Path, PathBuf}; | ||
|
||
use clap::{App, ArgMatches, SubCommand, AppSettings}; | ||
use clap::{App, AppSettings, ArgMatches, SubCommand}; | ||
|
||
use mdbook::errors::Result as Result3; | ||
use mdbook::MDBook; | ||
use mdbook::errors::{Result as Result3}; | ||
|
||
use failure::Error; | ||
#[cfg(feature = "linkcheck")] | ||
use mdbook::renderer::RenderContext; | ||
#[cfg(feature = "linkcheck")] | ||
use mdbook_linkcheck::{self, errors::BrokenLinks}; | ||
use failure::Error; | ||
|
||
fn main() { | ||
let d_message = "-d, --dest-dir=[dest-dir] | ||
|
@@ -21,18 +21,22 @@ fn main() { | |
'A directory for your book{n}(Defaults to Current Directory when omitted)'"; | ||
|
||
let matches = App::new("rustbook") | ||
.about("Build a book with mdBook") | ||
.author("Steve Klabnik <[email protected]>") | ||
.version(&*format!("v{}", crate_version!())) | ||
.setting(AppSettings::SubcommandRequired) | ||
.subcommand(SubCommand::with_name("build") | ||
.about("Build the book from the markdown files") | ||
.arg_from_usage(d_message) | ||
.arg_from_usage(dir_message)) | ||
.subcommand(SubCommand::with_name("linkcheck") | ||
.about("Run linkcheck with mdBook 3") | ||
.arg_from_usage(dir_message)) | ||
.get_matches(); | ||
.about("Build a book with mdBook") | ||
.author("Steve Klabnik <[email protected]>") | ||
.version(&*format!("v{}", crate_version!())) | ||
.setting(AppSettings::SubcommandRequired) | ||
.subcommand( | ||
SubCommand::with_name("build") | ||
.about("Build the book from the markdown files") | ||
.arg_from_usage(d_message) | ||
.arg_from_usage(dir_message), | ||
) | ||
.subcommand( | ||
SubCommand::with_name("linkcheck") | ||
.about("Run linkcheck with mdBook 3") | ||
.arg_from_usage(dir_message), | ||
) | ||
.get_matches(); | ||
|
||
// Check which subcomamnd the user ran... | ||
match matches.subcommand() { | ||
|
@@ -46,23 +50,36 @@ fn main() { | |
|
||
::std::process::exit(101); | ||
} | ||
}, | ||
} | ||
("linkcheck", Some(sub_matches)) => { | ||
if let Err(err) = linkcheck(sub_matches) { | ||
eprintln!("Error: {}", err); | ||
|
||
#[cfg(feature = "linkcheck")] | ||
{ | ||
if let Ok(broken_links) = err.downcast::<BrokenLinks>() { | ||
for cause in broken_links.links().iter() { | ||
eprintln!("\tCaused By: {}", cause); | ||
} | ||
// HACK: ignore timeouts | ||
let actually_broken = { | ||
#[cfg(feature = "linkcheck")] | ||
{ | ||
err.downcast::<BrokenLinks>() | ||
.unwrap_or(false) | ||
.links() | ||
.iter() | ||
.inspect(|cause| eprintln!("\tCaused By: {}", cause)) | ||
.any(|cause| !cause.contains("timed out")); | ||
} | ||
} | ||
|
||
::std::process::exit(101); | ||
#[cfg(not(feature = "linkcheck"))] | ||
{ | ||
false | ||
} | ||
}; | ||
|
||
if actually_broken { | ||
std::process::exit(101); | ||
} else { | ||
std::process::exit(0); | ||
} | ||
} | ||
}, | ||
} | ||
(_, _) => unreachable!(), | ||
}; | ||
} | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be
unreachable!
, just to be clear?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not unreachable, or am I wrong?. The idea is that actually_broken is set to false when not using the linkcheck feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
linkcheck()
function never returnsErr
, so this code block shouldn't ever be entered, if I'm reading it correctly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm... true. I did a bit of refactoring so we avoid calling it all. It's a bit annoying to try to avoid triggering
unused_*
lints.