Add aggregate command (#17)

.cl/add-aggregate-command.yml

@@ -0,0 +1,3 @@
+---
+- fixed: Fix bug that caused cl entries to be not properly nested in their branch directories
+- added: Add an aggregate subcommand to aggregate change entries into the CHANGELOG.md file

Cargo.toml

@@ -26,5 +26,7 @@ serde_yaml = "0.8.11"
 serde_json = "1.0.41"
 err-derive = "0.1.6"
 anyhow = "1.0.31"
-clparse = "0.7.0"
+clparse = "0.8.0"
 semver = "0.10.0"
+remove_empty_subdirs = "0.1.1"
+gag = "0.1.10"

README.md

@@ -60,6 +60,7 @@ SUBCOMMANDS:
     security      Creates a change entry to be placed in the Security section of the CHANGELOG
     edit          Opens the change file for direct editing
     yank          Mark a specific release as [YANKED]
+    aggregate     Aggregate change entries into the Unreleased section of the CHANGELOG
 ```
 
 ## Examples
@@ -128,3 +129,18 @@ Sometimes a release doesn't go as plan after the fact, and needs to be yanked
 from history. To do so, simply type `cl yank 1.2.3` where `1.2.3` is the
 release you wish to yank. This will tag the release as `[YANKED]` and remove
 it's link from the CHANGELOG.
+
+### Aggregating unreleased changes
+After you've made some changes and they've been merged, you'll likely want to
+aggregate your cl entries into the actual CHANGELOG.md file so they can be
+easily viewed by users. This can be achieved with the `aggregate` subcommand.
+
+```
+$ cl aggregate
+```
+
+This will take any change entries in the `.cl` directory, put them into the
+`CHANGELOG.md` file, and then remove them and any empty directories within the
+`.cl` directory.
+
+This command is useful to run via CI after a pull request has been merged.

src/main.rs

@@ -8,6 +8,8 @@ use clparse::changelog::{Change, Changelog, ReleaseBuilder};
 use err_derive::Error;
 use semver::Version;
 use scan_dir::ScanDir;
+use gag::Gag;
+use remove_empty_subdirs::remove_empty_subdirs;
 use std::env;
 use std::fs::{create_dir_all, OpenOptions};
 use std::io::{self, Write};
@@ -139,6 +141,10 @@ fn main() -> Result<()> {
                         .required(true)
                 )
         )
+        .subcommand(
+            SubCommand::with_name("aggregate")
+                .about("Aggregate change entries into the Unreleased section of the CHANGELOG")
+        )
         .get_matches();
 
     match matches.subcommand() {
@@ -203,6 +209,19 @@ fn main() -> Result<()> {
 
             Ok(())
         }
+        ("aggregate", Some(_)) => {
+            let mut changelog = get_changelog()?;
+
+            if let Some(unreleased) = changelog.unreleased_mut() {
+                unreleased.set_changes(get_all_changes()?);
+                std::fs::write(get_changelog_path()?, format!("{}", changelog))?;
+                remove_cl_change_entries()?;
+            } else {
+                bail!(ClError::ReleaseNotFound("Unreleased".to_string()));
+            }
+
+            Ok(())
+        }
         (kind, Some(sub_matches)) => {
             let description = sub_matches
                 .values_of("description")
@@ -250,7 +269,7 @@ fn get_cl_path() -> Result<PathBuf> {
 
     cl_path.push(head);
     create_dir_all(cl_path.clone())?;
-    cl_path.set_extension("yml");
+    cl_path.push("changes.yml");
 
     Ok(cl_path)
 }
@@ -284,8 +303,7 @@ fn get_unreleased_changes() -> Result<Vec<Change>> {
     Ok(get_changelog()?.unreleased_changes())
 }
 
-fn get_all_changes() -> Result<Vec<Change>> {
-    let mut changes: Vec<Change> = get_unreleased_changes()?;
+fn get_cl_entry_paths() -> Result<Vec<PathBuf>> {
     let mut logs: Vec<PathBuf> = Vec::new();
     let cl_dir = get_cl_dir()?;
 
@@ -302,6 +320,27 @@ fn get_all_changes() -> Result<Vec<Change>> {
         })
         .map_err(ClError::ScanError)?;
 
+    Ok(logs)
+}
+
+fn remove_cl_change_entries() -> Result<()> {
+    let logs = get_cl_entry_paths()?;
+
+    for log in logs {
+        std::fs::remove_file(log)?;
+    }
+
+    let gag = Gag::stdout()?;
+    remove_empty_subdirs(get_cl_dir()?.as_path())?;
+    drop(gag);
+
+    Ok(())
+}
+
+fn get_all_changes() -> Result<Vec<Change>> {
+    let mut changes: Vec<Change> = get_unreleased_changes()?;
+    let logs = get_cl_entry_paths()?;
+
     for log in logs {
         let mut cl_changes = get_changes(log)?;
         changes.append(&mut cl_changes);