Fix macOS CI deploy take 2.

Fix macOS CI deploy.

CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## mdBook 0.4.3
+[9278b83...9278b83](https://github.com/rust-lang/mdBook/compare/9278b83...4df9ec9)
+
+### Added
+- Added `output.html.cname` option to emit a `CNAME` file which is used by
+  GitHub Pages to know which domain is being used.
+  [#1311](https://github.com/rust-lang/mdBook/pull/1311)
+
+### Changed
+- `mdbook test` no longer stops on the first test failure, but instead will
+  run all the tests.
+  [#1313](https://github.com/rust-lang/mdBook/pull/1313)
+- Removed the `local` font source for Source Code Pro, as the locally
+  installed font may not render properly on FireFox on macOS.
+  [#1307](https://github.com/rust-lang/mdBook/pull/1307)
+
+### Fixed
+- Added newline to end of `.nojekyll` file.
+  [#1310](https://github.com/rust-lang/mdBook/pull/1310)
+- Fixed missing space before draft chapter titles.
+  [#1309](https://github.com/rust-lang/mdBook/pull/1309)
+
+## mdBook 0.4.2
+[649f355...9278b83](https://github.com/rust-lang/mdBook/compare/649f355...9278b83)
+
+### Changed
+- The "show hidden lines" icon has changed from the "expand" icon to an "eye".
+  [#1281](https://github.com/rust-lang/mdBook/pull/1281)
+- Updated highlight.js. This adds several languages: c, c-like (effectively
+  cpp), csharp (replaces cs), kotlin, less, lua, php-template, plaintext,
+  python-repl, r, scss, typescript.
+  [#1277](https://github.com/rust-lang/mdBook/pull/1277)
+
+### Fixed
+- Fixed SUMMARY links that contained newlines.
+  [#1291](https://github.com/rust-lang/mdBook/pull/1291)
+- Fixed SUMMARY links that contain `%20` spaces.
+  [#1293](https://github.com/rust-lang/mdBook/pull/1293)
+- Fixed favicon so that if only the png or svg is overridden, the other is not
+  automatically included in the `<link>` tag.
+  [#1272](https://github.com/rust-lang/mdBook/pull/1272)
+
 ## mdBook 0.4.1
 [d4df7e7...649f355](https://github.com/rust-lang/mdBook/compare/d4df7e7...649f355)
 
@@ -30,6 +72,8 @@
   can disable the 404 page generation, or set up your own 404 handling in your
   web server.
   [#1221](https://github.com/rust-lang/mdBook/pull/1221)
+- The `debug` and `output` features have been removed as they were unused.
+  [#1211](https://github.com/rust-lang/mdBook/pull/1211)
 - If you are using customized themes, you may want to consider setting the
   `preferred-dark-theme` config setting, as it now defaults to "navy".
   [#1199](https://github.com/rust-lang/mdBook/pull/1199)

Cargo.lock

@@ -723,7 +723,7 @@ checksum = "7ffc5c5338469d4d3ea17d269fa8ea3512ad247247c30bd2df69e68309ed0a08"
 
 [[package]]
 name = "mdbook"
-version = "0.4.1"
+version = "0.4.3"
 dependencies = [
  "ammonia",
  "anyhow",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mdbook"
-version = "0.4.1"
+version = "0.4.3"
 authors = [
     "Mathieu David <mathieudavid@mathieudavid.org>",
     "Michael-F-Bryan <michaelfbryan@gmail.com>",

README.md

@@ -209,7 +209,7 @@ tagged [E-Easy] and **we will gladly mentor you** so that you can successfully
 go through the process of fixing a bug or adding a new feature! Let us know if
 you need any help.
 
-For more info about contributing, check out our [contribution guide] who helps
+For more info about contributing, check out our [contribution guide] which helps
 you go through the build and contribution process!
 
 There is also a [rendered version][master-docs] of the latest API docs

book-example/src/README.md

@@ -1,8 +1,8 @@
 # mdBook
 
 **mdBook** is a command line tool and Rust crate to create books using Markdown
-files. It's very similar to Gitbook but written in
-[Rust](http://www.rust-lang.org).
+(as by the [CommonMark](https://commonmark.org/) specification) files. It's very
+similar to Gitbook but written in [Rust](http://www.rust-lang.org).
 
 What you are reading serves as an example of the output of mdBook and at the
 same time as a high-level documentation.

book-example/src/for_developers/backends.md

@@ -334,7 +334,9 @@ the usual `RUST_LOG` to control logging verbosity.
 If you enable a backend that isn't installed, the default behavior is to throw an error:
 
 ```text
-The command wasn't found, is the "wordcount" backend installed?
+The command `mdbook-wordcount` wasn't found, is the "wordcount" backend installed?
+If you want to ignore this error when the "wordcount" backend is not installed,
+set `optional = true` in the `[output.wordcount]` section of the book.toml configuration file.
 ```
 
 This behavior can be changed by marking the backend as optional.

book-example/src/format/config.md

@@ -210,6 +210,12 @@ The following configuration options are available:
 - **site-url:** The url where the book will be hosted. This is required to ensure
   navigation links and script/css imports in the 404 file work correctly, even when accessing
   urls in subdirectories. Defaults to `/`.
+- **cname:** The DNS subdomain or apex domain at which your book will be hosted.
+  This string will be written to a file named CNAME in the root of your site, as
+  required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages
+  site*][custom domain]).
+
+[custom domain]: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
 
 Available configuration options for the `[output.html.fold]` table:
 
@@ -273,6 +279,7 @@ no-section-label = false
 git-repository-url = "https://github.com/rust-lang/mdBook"
 git-repository-icon = "fa-github"
 site-url = "/example-book/"
+cname = "myproject.rs"
 input-404 = "not-found.md"
 
 [output.html.fold]

book-example/src/format/theme/index-hbs.md

@@ -19,7 +19,8 @@ Here is a list of the properties that are exposed:
 
 - ***language*** Language of the book in the form `en`, as specified in `book.toml` (if not specified, defaults to `en`). To use in <code
   class="language-html">\<html lang="{{ language }}"></code> for example.
-- ***title*** Title of the book, as specified in `book.toml`
+- ***title*** Title used for the current page. This is identical to `{{ book_title }} - {{ chapter_title }}` unless `book_title` is not set in which case it just defaults to the `chapter_title`.
+- ***book_title*** Title of the book, as specified in `book.toml`
 - ***chapter_title*** Title of the current chapter, as listed in `SUMMARY.md`
 
 - ***path*** Relative path to the original markdown file from the source

ci/install-rust.sh

@@ -12,7 +12,7 @@ TOOLCHAIN="$1"
 
 rustup set profile minimal
 rustup component remove --toolchain=$TOOLCHAIN rust-docs || echo "already removed"
-rustup update $TOOLCHAIN
+rustup update --no-self-update $TOOLCHAIN
 rustup default $TOOLCHAIN
 rustup -V
 rustc -Vv

ci/make-release.sh

@@ -11,13 +11,24 @@ fi
 TAG=${GITHUB_REF#*/tags/}
 
 host=$(rustc -Vv | grep ^host: | sed -e "s/host: //g")
-cargo rustc --bin mdbook --release -- -C lto
+export CARGO_PROFILE_RELEASE_LTO=true
+cargo build --bin mdbook --release
 cd target/release
 case $1 in
-  ubuntu* | macos*)
+  ubuntu*)
     asset="mdbook-$TAG-$host.tar.gz"
     tar czf ../../$asset mdbook
     ;;
+  macos*)
+    asset="mdbook-$TAG-$host.tar.gz"
+    # There is a bug with BSD tar on macOS where the first 8MB of the file are
+    # sometimes all NUL bytes. See https://github.com/actions/cache/issues/403
+    # and https://github.com/rust-lang/cargo/issues/8603 for some more
+    # information. An alternative solution here is to install GNU tar, but
+    # flushing the disk cache seems to work, too.
+    sudo /usr/sbin/purge
+    tar czf ../../$asset mdbook
+    ;;
   windows*)
     asset="mdbook-$TAG-$host.zip"
     7z a ../../$asset mdbook.exe

src/book/mod.rs

@@ -250,6 +250,7 @@ impl MDBook {
         // Index Preprocessor is disabled so that chapter paths continue to point to the
         // actual markdown files.
 
+        let mut failed = false;
         for item in book.iter() {
             if let BookItem::Chapter(ref ch) = *item {
                 let chapter_path = match ch.path {
@@ -282,7 +283,8 @@ impl MDBook {
                 let output = cmd.output()?;
 
                 if !output.status.success() {
-                    bail!(
+                    failed = true;
+                    error!(
                         "rustdoc returned an error:\n\
                         \n--- stdout\n{}\n--- stderr\n{}",
                         String::from_utf8_lossy(&output.stdout),
@@ -291,6 +293,9 @@ impl MDBook {
                 }
             }
         }
+        if failed {
+            bail!("One or more tests failed");
+        }
         Ok(())
     }
 

src/book/summary.rs

@@ -333,6 +333,7 @@ impl<'a> SummaryParser<'a> {
 
     /// Finishes parsing a link once the `Event::Start(Tag::Link(..))` has been opened.
     fn parse_link(&mut self, href: String) -> Link {
+        let href = href.replace("%20", " ");
         let link_content = collect_events!(self.stream, end Tag::Link(..));
         let name = stringify_events(link_content);
 
@@ -569,6 +570,7 @@ fn stringify_events(events: Vec<Event<'_>>) -> String {
         .into_iter()
         .filter_map(|t| match t {
             Event::Text(text) | Event::Code(text) => Some(text.into_string()),
+            Event::SoftBreak => Some(String::from(" ")),
             _ => None,
         })
         .collect()
@@ -926,4 +928,49 @@ mod tests {
 
         assert_eq!(got, should_be);
     }
+
+    /// Regression test for https://github.com/rust-lang/mdBook/issues/1218
+    /// Ensure chapter names spread across multiple lines have spaces between all the words.
+    #[test]
+    fn add_space_for_multi_line_chapter_names() {
+        let src = "- [Chapter\ntitle](./chapter.md)";
+        let should_be = vec![SummaryItem::Link(Link {
+            name: String::from("Chapter title"),
+            location: Some(PathBuf::from("./chapter.md")),
+            number: Some(SectionNumber(vec![1])),
+            nested_items: Vec::new(),
+        })];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn allow_space_in_link_destination() {
+        let src = "- [test1](./test%20link1.md)\n- [test2](<./test link2.md>)";
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("test1"),
+                location: Some(PathBuf::from("./test link1.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("test2"),
+                location: Some(PathBuf::from("./test link2.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
 }

src/config.rs

@@ -508,6 +508,13 @@ pub struct HtmlConfig {
     pub input_404: Option<String>,
     /// Absolute url to site, used to emit correct paths for the 404 page, which might be accessed in a deeply nested directory
     pub site_url: Option<String>,
+    /// The DNS subdomain or apex domain at which your book will be hosted. This
+    /// string will be written to a file named CNAME in the root of your site,
+    /// as required by GitHub Pages (see [*Managing a custom domain for your
+    /// GitHub Pages site*][custom domain]).
+    ///
+    /// [custom domain]: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
+    pub cname: Option<String>,
     /// This is used as a bit of a workaround for the `mdbook serve` command.
     /// Basically, because you set the websocket port from the command line, the
     /// `mdbook serve` command needs a way to let the HTML renderer know where
@@ -541,6 +548,7 @@ impl Default for HtmlConfig {
             git_repository_icon: None,
             input_404: None,
             site_url: None,
+            cname: None,
             livereload_url: None,
             redirect: HashMap::new(),
         }

src/renderer/html_handlebars/hbs_renderer.rs

@@ -184,9 +184,13 @@ impl HtmlHandlebars {
         write_file(
             destination,
             ".nojekyll",
-            b"This file makes sure that Github Pages doesn't process mdBook's output.",
+            b"This file makes sure that Github Pages doesn't process mdBook's output.\n",
         )?;
 
+        if let Some(cname) = &html_config.cname {
+            write_file(destination, "CNAME", format!("{}\n", cname).as_bytes())?;
+        }
+
         write_file(destination, "book.js", &theme.js)?;
         write_file(destination, "css/general.css", &theme.general_css)?;
         write_file(destination, "css/chrome.css", &theme.chrome_css)?;
@@ -478,7 +482,7 @@ impl Renderer for HtmlHandlebars {
         debug!("Register handlebars helpers");
         self.register_hbs_helpers(&mut handlebars, &html_config);
 
-        let mut data = make_data(&ctx.root, &book, &ctx.config, &html_config)?;
+        let mut data = make_data(&ctx.root, &book, &ctx.config, &html_config, &theme)?;
 
         // Print version
         let mut print_content = String::new();
@@ -551,6 +555,7 @@ fn make_data(
     book: &Book,
     config: &Config,
     html_config: &HtmlConfig,
+    theme: &Theme,
 ) -> Result<serde_json::Map<String, serde_json::Value>> {
     trace!("make_data");
 
@@ -567,6 +572,12 @@ fn make_data(
         "description".to_owned(),
         json!(config.book.description.clone().unwrap_or_default()),
     );
+    if theme.favicon_png.is_some() {
+        data.insert("favicon_png".to_owned(), json!("favicon.png"));
+    }
+    if theme.favicon_svg.is_some() {
+        data.insert("favicon_svg".to_owned(), json!("favicon.svg"));
+    }
     if let Some(ref livereload) = html_config.livereload_url {
         data.insert("livereload".to_owned(), json!(livereload));
     }

src/renderer/html_handlebars/helpers/toc.rs

@@ -108,32 +108,32 @@ impl HelperDef for RenderToc {
             }
 
             // Link
-            let path_exists = if let Some(path) = item.get("path") {
-                if !path.is_empty() {
-                    out.write("<a href=\"")?;
+            let path_exists = if let Some(path) =
+                item.get("path")
+                    .and_then(|p| if p.is_empty() { None } else { Some(p) })
+            {
+                out.write("<a href=\"")?;
 
-                    let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
-                        .with_extension("html")
-                        .to_str()
-                        .unwrap()
-                        // Hack for windows who tends to use `\` as separator instead of `/`
-                        .replace("\\", "/");
+                let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
+                    .with_extension("html")
+                    .to_str()
+                    .unwrap()
+                    // Hack for windows who tends to use `\` as separator instead of `/`
+                    .replace("\\", "/");
 
-                    // Add link
-                    out.write(&utils::fs::path_to_root(&current_path))?;
-                    out.write(&tmp)?;
-                    out.write("\"")?;
+                // Add link
+                out.write(&utils::fs::path_to_root(&current_path))?;
+                out.write(&tmp)?;
+                out.write("\"")?;
 
-                    if path == &current_path {
-                        out.write(" class=\"active\"")?;
-                    }
-
-                    out.write(">")?;
-                    true
-                } else {
-                    false
+                if path == &current_path {
+                    out.write(" class=\"active\"")?;
                 }
+
+                out.write(">")?;
+                true
             } else {
+                out.write("<div>")?;
                 false
             };
 
@@ -165,6 +165,8 @@ impl HelperDef for RenderToc {
 
             if path_exists {
                 out.write("</a>")?;
+            } else {
+                out.write("</div>")?;
             }
 
             // Render expand/collapse toggle

src/renderer/mod.rs

@@ -173,7 +173,9 @@ impl CmdRenderer {
                 return Ok(());
             } else {
                 error!(
-                    "The command `{}` wasn't found, is the `{}` backend installed?",
+                    "The command `{0}` wasn't found, is the \"{1}\" backend installed? \
+                    If you want to ignore this error when the \"{1}\" backend is not installed, \
+                    set `optional = true` in the `[output.{1}]` section of the book.toml configuration file.",
                     self.cmd, self.name
                 );
             }

src/theme/book.js

@@ -175,23 +175,23 @@ function playground_text(playground) {
 
         var buttons = document.createElement('div');
         buttons.className = 'buttons';
-        buttons.innerHTML = "<button class=\"fa fa-expand\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
+        buttons.innerHTML = "<button class=\"fa fa-eye\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
 
         // add expand button
         var pre_block = block.parentNode;
         pre_block.insertBefore(buttons, pre_block.firstChild);
 
         pre_block.querySelector('.buttons').addEventListener('click', function (e) {
-            if (e.target.classList.contains('fa-expand')) {
-                e.target.classList.remove('fa-expand');
-                e.target.classList.add('fa-compress');
+            if (e.target.classList.contains('fa-eye')) {
+                e.target.classList.remove('fa-eye');
+                e.target.classList.add('fa-eye-slash');
                 e.target.title = 'Hide lines';
                 e.target.setAttribute('aria-label', e.target.title);
 
                 block.classList.remove('hide-boring');
-            } else if (e.target.classList.contains('fa-compress')) {
-                e.target.classList.remove('fa-compress');
-                e.target.classList.add('fa-expand');
+            } else if (e.target.classList.contains('fa-eye-slash')) {
+                e.target.classList.remove('fa-eye-slash');
+                e.target.classList.add('fa-eye');
                 e.target.title = 'Show hidden lines';
                 e.target.setAttribute('aria-label', e.target.title);
 

src/theme/fonts/fonts.css

@@ -96,6 +96,5 @@
   font-family: 'Source Code Pro';
   font-style: normal;
   font-weight: 500;
-  src: local('Source Code Pro Medium'), local('SourceCodePro-Medium'),
-       url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+  src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
 }

src/theme/index.hbs

@@ -20,8 +20,12 @@
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="theme-color" content="#ffffff" />
 
+        {{#if favicon_svg}}
         <link rel="icon" href="{{ path_to_root }}favicon.svg">
+        {{/if}}
+        {{#if favicon_png}}
         <link rel="shortcut icon" href="{{ path_to_root }}favicon.png">
+        {{/if}}
         <link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
         <link rel="stylesheet" href="{{ path_to_root }}css/general.css">
         <link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">