Add changelog to book

Add the changelog to the book. It's no longer comitted, so it's good to
have the current version available somewhere.

type: documentation

.gitignore

@@ -3,6 +3,7 @@
 /book/book
 /book/src/SUMMARY.md
 /book/src/bittorrent.md
+/book/src/changelog.md
 /book/src/commands.md
 /book/src/commands/
 /book/src/faq.md

bin/gen/src/changelog.rs

@@ -99,18 +99,22 @@ impl Changelog {
 
     Self { releases }
   }
-}
 
-impl Display for Changelog {
+  #[throws]
-  #[throws(fmt::Error)]
+  pub(crate) fn render(&self, book: bool) -> String {
-  fn fmt(&self, f: &mut Formatter) {
+    let mut lines: Vec<String> = Vec::new();
-    writeln!(f, "Changelog")?;
+
-    writeln!(f, "=========")?;
+    lines.push("Changelog".into());
+    lines.push("=========".into());
 
     for release in &self.releases {
-      writeln!(f)?;
+      lines.push("".into());
-      writeln!(f)?;
+      lines.push("".into());
-      write!(f, "{}", release)?;
+      release.render(&mut lines, book)?;
-    }
+    }
+
+    let mut text = lines.join("\n");
+    text.push('\n');
+    text
   }
 }

bin/gen/src/entry.rs

@@ -43,48 +43,47 @@ impl Entry {
     }
   }
 
-  fn permanent_shorthash(&self) -> String {
+  fn shorthash(&self) -> String {
-    if self.head {
-      "x".repeat(12)
-    } else {
     self.hash[..12].into()
   }
-  }
-}
 
-impl Display for Entry {
+  #[throws]
-  #[throws(fmt::Error)]
+  pub(crate) fn render(&self, lines: &mut Vec<String>, book: bool) {
-  fn fmt(&self, f: &mut Formatter) {
+    let mut line = "- ".to_string();
+
     let url = self.url();
 
-    let shorthash = self.permanent_shorthash();
+    line.push_str(&format!(
-
-    write!(
-      f,
       "{} [`{}`]({}) {}",
-      self.metadata.kind.emoji(),
+      if book {
-      shorthash,
+        self.metadata.kind.emoji_character()
+      } else {
+        self.metadata.kind.emoji_name()
+      },
+      self.shorthash(),
       url,
       self.summary
-    )?;
+    ));
 
     if let Some(pr) = &self.metadata.pr {
       let n = pr.path_segments().unwrap().last().unwrap();
-      write!(f, " ([#{}]({}))", n, pr)?;
+      line.push_str(&format!(" ([#{}]({}))", n, pr));
     }
 
     if !self.metadata.fixes.is_empty() {
-      write!(f, " - Fixes ")?;
+      line.push_str(" - Fixes ");
 
       for (i, issue) in self.metadata.fixes.iter().enumerate() {
         if i > 0 {
-          write!(f, ", ")?;
+          line.push_str(", ");
         }
         let n = issue.path_segments().unwrap().last().unwrap();
-        write!(f, "[#{}]({})", n, issue)?;
+        line.push_str(&format!("[#{}]({})", n, issue));
       }
     }
 
-    write!(f, " - _{}_", self.author)?;
+    line.push_str(&format!(" - _{}_", self.author));
+
+    lines.push(line);
   }
 }

bin/gen/src/kind.rs

@@ -30,7 +30,23 @@ pub(crate) enum Kind {
 }
 
 impl Kind {
-  pub(crate) fn emoji(self) -> &'static str {
+  pub(crate) fn emoji_character(self) -> &'static str {
+    match self {
+      Self::Added => "✨",
+      Self::Breaking => "💥",
+      Self::Changed => "⚡️",
+      Self::Dependencies => "⬆️",
+      Self::Development => "🔧",
+      Self::Distribution => "📦",
+      Self::Documentation => "📚",
+      Self::Fixed => "🐛",
+      Self::Reform => "🎨",
+      Self::Release => "🔖",
+      Self::Testing => "✅",
+    }
+  }
+
+  pub(crate) fn emoji_name(self) -> &'static str {
     match self {
       Self::Added => ":sparkles:",
       Self::Breaking => ":boom:",

bin/gen/src/opt.rs

@@ -93,7 +93,7 @@ impl Opt {
 
     let path = project.root.join("CHANGELOG.md");
 
-    fs::write(&path, changelog.to_string()).context(error::Filesystem { path })?;
+    fs::write(&path, changelog.render(false)?).context(error::Filesystem { path })?;
   }
 
   #[throws]
@@ -124,6 +124,7 @@ impl Opt {
       "/README.md",
       "/book/src/SUMMARY.md",
       "/book/src/bittorrent.md",
+      "/book/src/changelog.md",
       "/book/src/commands.md",
       "/book/src/commands/*",
       "/book/src/faq.md",
@@ -182,9 +183,11 @@ impl Opt {
 
     gen(HEAD)?;
 
-    let head = project.repo.head()?.peel_to_commit()?;
+    let head = project.repo.head()?;
 
-    let parent = head.parent(0)?;
+    let head_commit = head.peel_to_commit()?;
+
+    let parent = head_commit.parent(0)?;
 
     let parent_hash = parent.id().to_string();
 
@@ -192,12 +195,20 @@ impl Opt {
 
     gen(&parent_hash)?;
 
-    cmd!("diff", "-r", parent_hash, HEAD)
+    cmd!("colordiff", "-ur", parent_hash, HEAD)
       .current_dir(tmp.path())
       .status_into_result()
       .ok();
 
-    cmd!("git", "checkout", &head.id().to_string()).status_into_result()?;
+    cmd!(
+      "git",
+      "checkout",
+      head
+        .shorthand()
+        .map(str::to_owned)
+        .unwrap_or_else(|| head_commit.id().to_string())
+    )
+    .status_into_result()?;
   }
 
   #[throws]
@@ -245,6 +256,11 @@ impl Opt {
     Summary::new(project).render_to(project.root.join("book/src/SUMMARY.md"))?;
 
     Introduction::new(&project.config).render_to(project.root.join("book/src/introduction.md"))?;
+
+    let changelog = Changelog::new(&project)?;
+
+    let dst = project.root.join("book/src/changelog.md");
+    fs::write(&dst, changelog.render(true)?).context(error::Filesystem { path: dst })?;
   }
 
   #[throws]

bin/gen/src/release.rs

@@ -6,9 +6,9 @@ pub(crate) struct Release {
   pub(crate) entries: Vec<Entry>,
 }
 
-impl Display for Release {
+impl Release {
-  #[throws(fmt::Error)]
+  #[throws]
-  fn fmt(&self, f: &mut Formatter) {
+  pub(crate) fn render(&self, lines: &mut Vec<String>, book: bool) {
     let time = self.time.format("%Y-%m-%d");
 
     let header = match &self.version {
@@ -19,11 +19,11 @@ impl Display for Release {
       None => format!("UNRELEASED - {}", time),
     };
 
-    writeln!(f, "{}", header)?;
+    lines.push(header.clone());
-    writeln!(f, "{}", "-".repeat(header.len()))?;
+    lines.push("-".repeat(header.len()));
 
     for entry in &self.entries {
-      writeln!(f, "- {}", entry)?;
+      entry.render(lines, book)?;
     }
   }
 }

bin/gen/templates/SUMMARY.md

@@ -5,6 +5,8 @@ Summary
 
 - [FAQ](./faq.md)
 
+- [Changelog](./changelog.md)
+
 {{commands}}
 
 - [Bittorrent](./bittorrent.md)