feat: enable commit bodies in changelog and fixes general warnings and updates (#49)

Allows commit bodies to show up in release notes, this is something I'd prefer as my releases are usually short, and I'd like to see these as I don't use pull requests as often, and often miss the context, as I don't link to commits currently.

Also fixes a lot of warnings and reintroduces failing tests, still not perfect, but better than before.
Co-authored-by: kjuulh <contact@kjuulh.io>
Co-committed-by: kjuulh <contact@kjuulh.io>

CHANGELOG.md

@@ -110,7 +110,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - add mkdocs build
 - add basic version
 - update with repository
-- add publishable to rest
+- add publish to rest
 - hack get in control of log level
 
 ### Docs

Cargo.toml

@@ -1,7 +1,5 @@
 [workspace]
-members = [
-  "crates/*"
-]
+members = ["crates/*"]
 resolver = "2"
 
 [workspace.dependencies]
@@ -15,17 +13,17 @@ cuddle-please-actions = { path = "crates/cuddle-please-actions", version = "0.1.
 anyhow = { version = "1.0.81" }
 tracing = { version = "0.1", features = ["log"] }
 tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
-clap = { version = "4.5.4", features = ["derive", "env"] }
-dotenv = { version = "0.15.0" }
+clap = { version = "4.5.23", features = ["derive", "env"] }
+dotenvy = { version = "0.15.7" }
 url = { version = "2.5.0" }
 serde_yaml = { version = "0.9.34+deprecated" }
-yaml-rust2 = {version = "0.8.0"}
+yaml-rust2 = { version = "0.8.0" }
 serde = { version = "1", features = ["derive"] }
 semver = "1.0.22"
 conventional_commit_parser = "0.9.4"
 tempdir = "0.3.7"
 reqwest = { version = "0.12.3" }
-git-cliff-core = "2.2.0"
+git-cliff-core = "2.7.0"
 regex = "1.10.4"
 chrono = "0.4.37"
 lazy_static = "1.4.0"

crates/cuddle-please-actions/Cargo.toml

@@ -6,7 +6,7 @@ readme = "../../README.md"
 license-file = "../../LICENSE"
 version = "0.1.0"
 edition = "2021"
-publishable = true
+publish = true
 
 [dependencies]
 anyhow.workspace = true

crates/cuddle-please-actions/src/rust_action.rs

@@ -1,7 +1,5 @@
 use std::io::Write;
 
-use anyhow::Context;
-
 use crate::{actions::Action, ActionConfig};
 
 #[derive(Default, Clone)]

crates/cuddle-please-commands/Cargo.toml

@@ -6,7 +6,7 @@ readme = "../../README.md"
 license-file = "../../LICENSE"
 version = "0.1.0"
 edition = "2021"
-publishable = true
+publish = true
 
 
 [dependencies]
@@ -18,7 +18,7 @@ anyhow.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 clap.workspace = true
-dotenv.workspace = true
+dotenvy.workspace = true
 serde_yaml.workspace = true
 serde.workspace = true
 reqwest = { workspace = true, features = ["blocking", "json"] }

crates/cuddle-please-commands/src/release_command.rs

@@ -1,3 +1,5 @@
+use std::path::Path;
+
 use cuddle_please_actions::Actions;
 use cuddle_please_frontend::PleaseConfig;
 
@@ -128,6 +130,7 @@ impl ReleaseCommandHandler {
         Ok(())
     }
 
+    #[allow(clippy::too_many_arguments)]
     fn create_pull_request(
         &self,
         changelog_placement: std::path::PathBuf,
@@ -225,7 +228,7 @@ impl ReleaseCommandHandler {
 fn compose_changelog(
     commit_strs: &Vec<String>,
     next_version: &Version,
-    source: &std::path::PathBuf,
+    source: &Path,
 ) -> Result<(std::path::PathBuf, String, Option<String>), anyhow::Error> {
     let builder = ChangeLogBuilder::new(commit_strs, next_version.to_string()).build();
     let changelog_placement = source.join("CHANGELOG.md");

crates/cuddle-please-frontend/Cargo.toml

@@ -6,14 +6,14 @@ readme = "../../README.md"
 license-file = "../../LICENSE"
 version = "0.1.0"
 edition = "2021"
-publishable = true
+publish = true
 
 [dependencies]
 anyhow.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 clap.workspace = true
-dotenv.workspace = true
+dotenvy.workspace = true
 serde_yaml.workspace = true
 serde.workspace = true
 chrono.workspace = true

crates/cuddle-please-frontend/src/stage0_config.rs

@@ -28,14 +28,8 @@ pub struct PleaseConfigBuilder {
 impl PleaseConfigBuilder {
     pub fn merge(&mut self, config: &PleaseConfigBuilder) -> &Self {
         let config = config.clone();
-        let mut fproject = match self.project.clone() {
-            None => PleaseProjectConfigBuilder::default(),
-            Some(project) => project,
-        };
-        let mut fsettings = match self.settings.clone() {
-            None => PleaseSettingsConfigBuilder::default(),
-            Some(settings) => settings,
-        };
+        let mut fproject = self.project.clone().unwrap_or_default();
+        let mut fsettings = self.settings.clone().unwrap_or_default();
 
         if let Some(project) = config.project {
             if let Some(owner) = project.owner {

crates/cuddle-please-misc/Cargo.toml

@@ -6,7 +6,7 @@ readme = "../../README.md"
 license-file = "../../LICENSE"
 version = "0.1.0"
 edition = "2021"
-publishable = true
+publish = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -15,7 +15,7 @@ anyhow.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 clap.workspace = true
-dotenv.workspace = true
+dotenvy.workspace = true
 serde_yaml.workspace = true
 serde.workspace = true
 reqwest = { workspace = true, features = ["blocking", "json"] }
@@ -29,6 +29,9 @@ chrono.workspace = true
 lazy_static.workspace = true
 parse-changelog.workspace = true
 
+# Cliff depends on 13.1.0, which is a broken release
+cacache = "=13.0.0"
+
 [dev-dependencies]
 tracing-test = { workspace = true, features = ["no-env-filter"] }
 pretty_assertions.workspace = true

crates/cuddle-please-misc/src/cliff/mod.rs

@@ -3,7 +3,7 @@ use chrono::{DateTime, NaiveDate, Utc};
 use git_cliff_core::{
     changelog::Changelog,
     commit::Commit,
-    config::{Bump, ChangelogConfig, CommitParser, Config, GitConfig, Remote, RemoteConfig},
+    config::{Bump, ChangelogConfig, CommitParser, Config, GitConfig, RemoteConfig},
     release::Release,
 };
 use regex::Regex;
@@ -79,6 +79,7 @@ impl ChangeLogBuilder {
                 previous: None,
                 message: None,
                 repository: None,
+                extra: None,
             },
             config: self.config,
             release_link: self.release_link,
@@ -225,6 +226,8 @@ fn default_changelog_config(header: Option<String>, release_link: Option<&str>)
         footer: None,
         trim: Some(true),
         postprocessors: None,
+        render_always: None,
+        output: None,
     }
 }
 
@@ -240,6 +243,11 @@ fn default_changelog_body_config(release_link: Option<&str>) -> String {
 {% else -%}
 - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message }}
 {% endif -%}
+{%- if commit.body -%}
+{%- if commit.body | length > 0 -%}
+{% raw %}  {% endraw %}{{ commit.body | trim }}
+{% endif -%}
+{% endif -%}
 {% endfor -%}
 {% endfor %}"#;
 
@@ -512,7 +520,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     #[test]
     fn generates_changelog() {
         let commits: Vec<&str> = vec![
-            "feat: some feature",
+            "feat: some feature
+
+some body",
             "some random commit",
             "fix: some fix",
             "chore(scope): some chore",
@@ -533,6 +543,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - some feature
+  some body
 
 ### Fixed
 - some fix

crates/cuddle-please-misc/src/gitea_client.rs

@@ -602,7 +602,7 @@ mod test {
         let (expected, actual) = get_commits("second-sha".into()).unwrap();
 
         assert_eq!(
-            expected.get(0).unwrap().clone().as_slice(),
+            expected.first().unwrap().clone().as_slice(),
             actual.as_slice()
         );
     }

crates/cuddle-please-misc/src/local_git_client.rs

@@ -1,5 +1,6 @@
 use crate::RemoteGitEngine;
 
+#[derive(Default)]
 pub struct LocalGitClient {}
 
 impl LocalGitClient {

crates/cuddle-please-release-strategy/Cargo.toml

@@ -6,7 +6,7 @@ version = "0.1.0"
 edition = "2021"
 readme = "../../README.md"
 license-file = "../../LICENSE"
-publishable = true
+publish = true
 
 [dependencies]
 anyhow.workspace = true

crates/cuddle-please-release-strategy/src/strategy.rs

@@ -2,11 +2,13 @@ use std::path::PathBuf;
 
 use serde::{Deserialize, Serialize};
 
+#[allow(dead_code)]
 pub struct UpdateOptions {
     next_version: String,
     global_changelog: String,
 }
 
+#[allow(dead_code)]
 pub type Projects = Vec<Project>;
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
@@ -22,7 +24,7 @@ pub enum ProjectType {
     #[serde(alias = "rust_workspace")]
     RustWorkspace,
     #[cfg(feature = "rust-crate")]
-    #[serde(alias = "json_edit")]
+    #[serde(alias = "rust_crate")]
     RustCrate,
     #[cfg(feature = "toml-edit")]
     #[serde(alias = "toml_edit")]
@@ -35,12 +37,13 @@ pub enum ProjectType {
     JsonEdit,
 }
 
+#[allow(dead_code)]
 impl Project {
     pub fn new(path: Option<PathBuf>, r#type: ProjectType) -> Self {
         Self { path, r#type }
     }
 
-    pub fn execute(&self, options: &UpdateOptions) -> anyhow::Result<()> {
+    pub fn execute(&self, _options: &UpdateOptions) -> anyhow::Result<()> {
         match self.r#type {
             #[cfg(feature = "rust-workspace")]
             ProjectType::RustWorkspace => todo!(),
@@ -53,7 +56,5 @@ impl Project {
             #[cfg(feature = "json-edit")]
             ProjectType::JsonEdit => todo!(),
         }
-
-        Ok(())
     }
 }

crates/cuddle-please/Cargo.toml

@@ -6,7 +6,7 @@ readme = "../../README.md"
 license-file = "../../LICENSE"
 version = "0.1.0"
 edition = "2021"
-publishable = true
+publish = true
 
 [dependencies]
 cuddle-please-frontend.workspace = true
@@ -17,7 +17,7 @@ anyhow.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 clap.workspace = true
-dotenv.workspace = true
+dotenvy.workspace = true
 serde_yaml.workspace = true
 serde.workspace = true
 reqwest = { workspace = true, features = ["blocking", "json"] }

crates/cuddle-please/src/main.rs

@@ -1,7 +1,7 @@
 use cuddle_please_commands::PleaseCommand;
 
 fn main() -> anyhow::Result<()> {
-    dotenv::dotenv().ok();
+    dotenvy::dotenv().ok();
 
     let current_dir = std::env::current_dir().ok();
     let current_dir = current_dir.as_deref();

crates/cuddle-please/tests/config.rs

@@ -6,6 +6,7 @@ use tracing_test::traced_test;
 
 use crate::common::{assert_output, get_test_data_path};
 
+#[allow(dead_code)]
 fn get_base_args<'a>() -> Vec<&'a str> {
     vec![
         "cuddle-please",
@@ -25,6 +26,7 @@ PleaseConfig
   api_url: https://some-example.gitea-instance
 "#;
 
+#[allow(dead_code)]
 #[traced_test]
 fn test_config_from_current_dir() {
     let args = get_base_args();
@@ -38,6 +40,7 @@ fn test_config_from_current_dir() {
     assert_output(ui, EXPECTED_OUTPUT, "");
 }
 
+#[allow(dead_code)]
 #[traced_test]
 fn test_config_from_source_dir() {
     let mut args = get_base_args();
@@ -53,6 +56,7 @@ fn test_config_from_source_dir() {
     assert_output(ui, EXPECTED_OUTPUT, "");
 }
 
+#[allow(dead_code)]
 #[traced_test]
 fn test_config_from_stdin() {
     let mut args = get_base_args();
@@ -72,6 +76,7 @@ settings:
     assert_output(ui, EXPECTED_OUTPUT, "");
 }
 
+#[allow(dead_code)]
 #[traced_test]
 fn test_config_fails_when_not_path_is_set() {
     let args = get_base_args();

crates/cuddle-please/tests/vcs.rs

@@ -16,15 +16,18 @@ fn test_vcs_get_noop() {
 #[traced_test]
 fn test_vcs_get_git_found() {
     let testdata = get_test_data_path("git-found");
+    if let Err(e) = std::fs::create_dir_all(&testdata) {
+        tracing::error!("failed to create dir: {}", e);
+    }
     if let Err(e) = std::process::Command::new("git")
         .arg("init")
         .arg(".")
         .current_dir(&testdata)
         .output()
     {
-        println!("{e}");
+        println!("testdata git dir not found: {e}");
     }
-    return;
+
     let git = VcsClient::new_git(&testdata, None::<String>, None::<String>, "".into()).unwrap();
     assert_eq!(
         git,