Merge branch 'changelog-generation'

Author: Byron

CHANGELOG.md

@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
 ## v0.5.0 and v0.6.0
 
 Maintenance release without any new features.

Cargo.lock

@@ -10,10 +10,10 @@ try-publish-all: ## Dry-run publish all crates in the currently set version if t
 	cargo run --package cargo-smart-release --bin cargo-smart-release -- smart-release gitoxide
 
 try-bump-minor-version: ## Show how updating the minor version of PACKAGE=<name> would look like.
-	cargo run --package cargo-smart-release --bin cargo-smart-release -- smart-release --update-crates-index --bump minor --skip-dependencies --skip-publish --skip-tag --skip-push -v $(PACKAGE)
+	cargo run --package cargo-smart-release --bin cargo-smart-release -- smart-release --update-crates-index --bump minor --no-dependencies --no-publish --no-tag --no-push -v $(PACKAGE)
 
 bump-minor-version: ## Similar to try-bump-minor-version, but actually performs the operation on PACKAGE=<name>
-	cargo run --package cargo-smart-release --bin cargo-smart-release -- smart-release --update-crates-index --bump minor --skip-dependencies --skip-publish --skip-tag --skip-push -v $(PACKAGE) --execute
+	cargo run --package cargo-smart-release --bin cargo-smart-release -- smart-release --update-crates-index --bump minor --no-dependencies --skip-publish --skip-tag --skip-push -v $(PACKAGE) --execute
 
 ##@ Release Builds
 
@@ -308,6 +308,6 @@ force-update-assets: ## As update-assets, but will run git to update the baselin
 check-size: ## Run cargo-diet on all crates to see that they are still in bound
 	./etc/check-package-size.sh
 
-rustfmt: ## run nightly rustfmt for its extra features, but check that it won't upset stable rustfmt
+fmt: ## run nightly rustfmt for its extra features, but check that it won't upset stable rustfmt
 	cargo +nightly fmt --all -- --config-path rustfmt-nightly.toml
 	cargo +stable fmt --all -- --check

Makefile

@@ -1,38 +1,68 @@
-### v0.4.0 (2021-09-??)
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
 
 - Conservative pre-release version handling along with a flag to turn it off. See [this issue][194] for details.
 - Rename `--allow-auto-publish-of-stable-crates` to `--no-auto-publish-of-stable-crates`, inverting its meaning.
 - Add `--no-multi-crate-release` flag to return to previous default behaviour. All crate manifest changes are put into one commit.
 - automatically bump pre-release transient dependents of published crates to prevent breakage down the road unless 
   `--no-isolate-dependencies-from-breaking-change` is set.
 
-[194]: https://github.com/Byron/gitoxide/issues/194
+## v0.3.1 (2021-09-07) - internal improvements
+### Thanks Clippy…
+
+Clippy is a linter to help keeping code idiomatic. It was helpful 18 times in this release.
 
-### v0.3.1 (2021-09-07) - internal improvements
+## v0.3.1 (2021-09-07)
 
-### v0.3.0 (2021-08-27)
+## v0.3.0 (2021-08-27)
 
 - add `--skip-dependencies` flag
 - add `--verbose` flag and be less verbose in dry-runs by default to provide only essential information
 - improvements to notification clarity
 
-#### Breaking
+### Breaking
 
 - Use short flag for `--no-bump-on-demand` in `--bump-dependencies`
 
-### v0.2.4 (2021-08-15)
+### Thanks Clippy…
+
+Clippy is a linter to help keeping code idiomatic. It was helpful 9 times in this release.
+
+## v0.2.4 (2021-08-15)
 
 - Fix auto-push functionality
 
-### v0.2.3 (2021-08-15)
+## v0.2.3 (2021-08-15)
 
 - Less verbosity by default which is helpful on the first run to get an overview. Use `--verbose/-v` for all the details.
 - Also push tags and HEAD by default, unless `--skip-push` is specified.
 
-### v0.2.2 (2021-08-15)
+### Thanks Clippy…
+
+Clippy is a linter to help keeping code idiomatic. It was helpful 1 time in this release.
+
+## v0.2.2 (2021-08-15)
 
 - support for unsorted packed-refs files
 
-### v0.1.0 (2021-08-13)
+## v0.2.1 (2021-08-13)
+
+## v0.2.0 (2021-08-13)
+
+### Thanks Clippy…
+
+Clippy is a linter to help keeping code idiomatic. It was helpful 1 time in this release.
+
+## v0.1.0 (2021-08-13)
 
 - initial release
+### Thanks Clippy…
+
+Clippy is a linter to help keeping code idiomatic. It was helpful 2 times in this release.
+

cargo-smart-release/CHANGELOG.md

@@ -8,16 +8,19 @@ license = "MIT OR Apache-2.0"
 edition = "2018"
 categories = ["development-tools::cargo-plugins"]
 keywords = ["cargo"]
+include = ["src/**/*", "README.md", "CHANGELOG.md", "!**/tests/**/*"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [[bin]]
 name = "cargo-smart-release"
 path = "src/cli/main-smart-release.rs"
+test = false
 
 [[bin]]
 name = "cargo-changelog"
 path = "src/cli/main-changelog.rs"
+test = false
 
 [features]
 cache-efficiency-debug = ["git-repository/cache-efficiency-debug"]
@@ -35,3 +38,9 @@ crates-index = "0.17.0"
 cargo_toml = "0.9.2"
 nom = { version = "7", default-features = false, features = ["std"]}
 git-conventional = "0.10.3"
+time = "0.3.2"
+pulldown-cmark = "0.8.0"
+
+[dev-dependencies]
+insta = "1.8.0"
+git-testtools = { path = "../tests/tools"}

cargo-smart-release/Cargo.toml

@@ -0,0 +1,39 @@
+use std::{io, path::Path, process::Command};
+
+pub struct Support {
+    bat_found: bool,
+}
+
+impl Default for Support {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl Support {
+    pub fn new() -> Self {
+        Support {
+            bat_found: Command::new("bat").arg("--version").output().is_ok(),
+        }
+    }
+
+    pub fn display_to_tty(&self, path: &Path) -> io::Result<()> {
+        if !self.bat_found {
+            log::info!(
+                "Would want to use 'bat' for colored preview of '{}', but it wasn't available in the PATH.",
+                path.display()
+            );
+            return Ok(());
+        }
+        if Command::new("bat")
+            .args(&["--paging=always", "-l=md"])
+            .arg(path)
+            .status()?
+            .success()
+        {
+            Ok(())
+        } else {
+            Err(io::Error::new(io::ErrorKind::Other, "bat exited with an error"))
+        }
+    }
+}

cargo-smart-release/src/bat.rs

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+