feat!: PrepareRelease now git adds all modified files. (#267)

Closes #215

Co-authored-by: Dylan Anthony <[email protected]>

Author: dbanty

Diff for: Cargo.lock

@@ -1,6 +1,6 @@
 # PrepareRelease step
 
-This will look through all commits since the version tag and parse any [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) it finds. It will then bump the package version (depending on the [Semantic Versioning] rule determined from the commits) and add a new changelog entry using the [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) format.
+This will look through all commits since the version tag and parse any [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) it finds. It will then bump the package version (depending on the [Semantic Versioning] rule determined from the commits) and add a new changelog entry using the [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) format. Any files altered (`versioned_files` and `changelog`) will be staged for commit with `git add` **but not committed**.
 
 The version bumping follows the same rules and logic as the [BumpVersion] step, with the rule selected for you automatically. Which files are edited (both for versioning and changelog) is determined by the [packages] section.
 

Diff for: docs/src/config/step/PrepareRelease.md

@@ -34,17 +34,7 @@ name = "release"
 [[workflows.steps]]
 type = "PrepareRelease"
 
-# Updates Cargo.lock from Cargo.toml so the versions match.
-[[workflow.steps]]
-type = "Command"
-command = "cargo update -w"
-
-# Add the freshly modified changes
-[[workflows.steps]]
-type = "Command"
-command = "git add Cargo.toml Cargo.lock CHANGELOG.md"
-
-# Commit the changes (make sure this is run on your default branch!)
+# Commit the changes that PrepareRelease added
 [[workflows.steps]]
 type = "Command"
 command = "git commit -m \"chore: Bump to version\""
@@ -82,17 +72,7 @@ name = "release"
 [[workflows.steps]]
 type = "PrepareRelease"
 
-# Updates Cargo.lock from Cargo.toml so the versions match.
-[[workflow.steps]]
-type = "Command"
-command = "cargo update -w"
-
-# Add the freshly modified changes
-[[workflows.steps]]
-type = "Command"
-command = "git add Cargo.toml Cargo.lock CHANGELOG.md"
-
-# Commit the changes (make sure this is your default branch!)
+# Commit the changes that PrepareRelease made
 [[workflows.steps]]
 type = "Command"
 command = "git commit -m \"chore: Bump to version\""
@@ -128,17 +108,7 @@ name = "release"
 [[workflows.steps]]
 type = "PrepareRelease"
 
-# Updates Cargo.lock from Cargo.toml so the versions match.
-[[workflow.steps]]
-type = "Command"
-command = "cargo update -w"
-
-# Add the freshly modified changes
-[[workflows.steps]]
-type = "Command"
-command = "git add Cargo.lock knope/Cargo.toml knope/CHANGELOG.md knope-utils/Cargo.toml knope-utils/CHANGELOG.md"
-
-# Commit the changes (make sure this is run on your default branch!)
+# Commit the changes that PrepareRelease made
 [[workflows.steps]]
 type = "Command"
 command = "git commit -m \"chore: Prepare releases\""

Diff for: docs/src/config/step/Release.md

@@ -140,17 +140,17 @@ pub(crate) fn generate() -> Result<()> {
             github = Some(GitHub { owner, repo });
             vec![
                 Step::Command {
-                    command: String::from("git add . && git commit -m \"chore: prepare release $version\" && git push"),
+                    command: String::from(
+                        "git commit -m \"chore: prepare release $version\" && git push",
+                    ),
                     variables: Some(variables),
                 },
                 Step::Release,
             ]
         }
         _ => vec![
             Step::Command {
-                command: String::from(
-                    "git add . && git commit -m \"chore: prepare release $version\"",
-                ),
+                command: String::from("git commit -m \"chore: prepare release $version\""),
                 variables: Some(variables),
             },
             Step::Release,

Diff for: src/config.rs

@@ -1,3 +1,4 @@
+use std::path::PathBuf;
 use std::str::FromStr;
 
 use git2::build::CheckoutBuilder;
@@ -124,6 +125,46 @@ fn select_issue_from_branch_name(ref_name: &str) -> Result<Issue, StepError> {
     Ok(Issue { key, summary })
 }
 
+#[cfg(test)]
+mod test_select_issue_from_branch_name {
+    use super::*;
+
+    #[test]
+    fn jira_style() {
+        let issue = select_issue_from_branch_name("ABC-123-some-summary")
+            .expect("Failed to parse branch name");
+
+        assert_eq!(
+            issue,
+            Issue {
+                key: "ABC-123".to_string(),
+                summary: "some-summary".to_string(),
+            }
+        );
+    }
+
+    #[test]
+    fn github_style() {
+        let issue =
+            select_issue_from_branch_name("123-some-summary").expect("Failed to parse branch name");
+
+        assert_eq!(
+            issue,
+            Issue {
+                key: "123".to_string(),
+                summary: "some-summary".to_string(),
+            }
+        );
+    }
+
+    #[test]
+    fn no_number() {
+        let result = select_issue_from_branch_name("some-summary");
+
+        assert!(result.is_err());
+    }
+}
+
 fn create_branch<'repo>(
     repo: &'repo Repository,
     name: &str,
@@ -190,6 +231,21 @@ pub(crate) fn branch_name_from_issue(issue: &Issue) -> String {
     format!("{}-{}", issue.key, issue.summary.to_ascii_lowercase()).replace(' ', "-")
 }
 
+#[cfg(test)]
+mod test_branch_name_from_issue {
+    use super::*;
+
+    #[test]
+    fn branch_name_from_issue() {
+        let issue = Issue {
+            key: "FLOW-5".to_string(),
+            summary: "A test issue".to_string(),
+        };
+        let branch_name = super::branch_name_from_issue(&issue);
+        assert_eq!(&branch_name, "FLOW-5-a-test-issue");
+    }
+}
+
 pub(crate) fn get_commit_messages_after_last_stable_version(
     package_name: &Option<String>,
 ) -> Result<Vec<String>, StepError> {
@@ -243,57 +299,12 @@ pub(crate) fn get_commit_messages_after_last_stable_version(
     Ok(messages)
 }
 
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn branch_name_from_issue() {
-        let issue = Issue {
-            key: "FLOW-5".to_string(),
-            summary: "A test issue".to_string(),
-        };
-        let branch_name = super::branch_name_from_issue(&issue);
-        assert_eq!(&branch_name, "FLOW-5-a-test-issue");
-    }
-}
-
-#[cfg(test)]
-mod test_select_issue_from_branch_name {
-    use super::*;
-
-    #[test]
-    fn jira_style() {
-        let issue = select_issue_from_branch_name("ABC-123-some-summary")
-            .expect("Failed to parse branch name");
-
-        assert_eq!(
-            issue,
-            Issue {
-                key: "ABC-123".to_string(),
-                summary: "some-summary".to_string()
-            }
-        );
-    }
-
-    #[test]
-    fn github_style() {
-        let issue =
-            select_issue_from_branch_name("123-some-summary").expect("Failed to parse branch name");
-
-        assert_eq!(
-            issue,
-            Issue {
-                key: "123".to_string(),
-                summary: "some-summary".to_string()
-            }
-        );
-    }
-
-    #[test]
-    fn no_number() {
-        let result = select_issue_from_branch_name("some-summary");
-
-        assert!(result.is_err());
+/// Add some files to Git to be committed later.
+pub(crate) fn add_files(file_names: &[&PathBuf]) -> Result<(), StepError> {
+    let repo = Repository::open(".").map_err(|_| StepError::NotAGitRepo)?;
+    let mut index = repo.index()?;
+    for file_name in file_names {
+        index.add_path(file_name)?;
     }
+    index.write().map_err(StepError::from)
 }

Diff for: src/git.rs

@@ -1,8 +1,9 @@
+use std::io::Write;
+
 use git_conventional::{Commit, Type};
 use log::debug;
-use std::io::Write;
 
-use crate::git::get_commit_messages_after_last_stable_version;
+use crate::git::{add_files, get_commit_messages_after_last_stable_version};
 use crate::releases::semver::PackageVersion;
 use crate::releases::Package;
 use crate::step::StepError;
@@ -422,6 +423,7 @@ fn prepare_release_for_package(
         if let Some(changelog) = changelog {
             let contents = add_version_to_changelog(&changelog.content, &new_changes);
             std::fs::write(&changelog.path, contents)?;
+            add_files(&[&changelog.path])?;
         }
         Ok(Some(release))
     }

Diff for: src/releases/conventional_commits.rs

@@ -41,7 +41,7 @@ pub(crate) struct VersionedFile {
     /// The type of file format that `content` is.
     pub(crate) format: PackageFormat,
     /// The path to the file that was parsed.
-    path: PathBuf,
+    pub(crate) path: PathBuf,
     /// The raw content of the package manager file so it doesn't have to be read again.
     content: String,
 }

Diff for: src/releases/package.rs

@@ -1,6 +1,7 @@
 use semver::{Prerelease, Version};
 use serde::{Deserialize, Serialize};
 
+use crate::git::add_files;
 use crate::releases::git::get_current_versions_from_tag;
 use crate::releases::package::Package;
 use crate::releases::CurrentVersions;
@@ -169,9 +170,12 @@ fn set_version(
         version,
     } = package_version;
     let latest = version.latest();
+    let mut paths = Vec::with_capacity(package.versioned_files.len());
     for versioned_file in &mut package.versioned_files {
         versioned_file.set_version(latest)?;
+        paths.push(&versioned_file.path);
     }
+    add_files(&paths)?;
     Ok(PackageVersion { version, package })
 }
 

Diff for: src/releases/semver.rs

@@ -6,7 +6,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\" && git push"
+command = "git commit -m \"chore: prepare release $version\" && git push"
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/github/knope.toml

@@ -6,7 +6,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/no_remote/knope.toml

@@ -10,7 +10,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/package_changelog/changelog_knope.toml

@@ -9,7 +9,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/package_changelog/no_changelog_knope.toml

@@ -9,7 +9,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/packages/Cargo.toml_knope.toml

@@ -9,7 +9,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/packages/multiple_knope.toml

@@ -9,7 +9,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/packages/package.json_knope.toml

@@ -9,7 +9,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add . && git commit -m \"chore: prepare release $version\""
+command = "git commit -m \"chore: prepare release $version\""
 
 [workflows.steps.variables]
 "$version" = "Version"

Diff for: tests/generate/packages/pyproject.toml_knope.toml

@@ -6,5 +6,5 @@ Would add the following to CHANGELOG.md:
 
 - New feature
 
-Would run git add Cargo.toml && git commit -m "chore: Bump to 1.1.0"
+Would run git commit -m "chore: Bump to 1.1.0"
 Would create Git tag v1.1.0

Diff for: tests/git_release/dry_run_output.txt

@@ -10,7 +10,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add Cargo.toml && git commit -m \"chore: Bump to version\""
+command = "git commit -m \"chore: Bump to version\""
 variables = { "version" = "Version" }
 
 [[workflows.steps]]

Diff for: tests/git_release/knope.toml

@@ -14,6 +14,6 @@ Would add the following to SECOND_CHANGELOG.md:
 
 - New breaking feature
 
-Would run git add Cargo.toml pyproject.toml package.json FIRST_CHANGELOG.md SECOND_CHANGELOG.md && git commit -m "chore: Prepare release"
+Would run git commit -m "chore: Prepare release"
 Would create Git tag first/v2.0.0
 Would create Git tag second/v0.5.0

Diff for: tests/git_release/multiple_packages/dry_run_output.txt

@@ -14,7 +14,7 @@ type = "PrepareRelease"
 
 [[workflows.steps]]
 type = "Command"
-command = "git add Cargo.toml pyproject.toml package.json FIRST_CHANGELOG.md SECOND_CHANGELOG.md && git commit -m \"chore: Prepare release\""
+command = "git commit -m \"chore: Prepare release\""
 
 [[workflows.steps]]
 type = "Release"

Diff for: tests/git_release/multiple_packages/knope.toml

@@ -1,3 +1,4 @@
 [..] chore: Bump to 1.1.0
- 1 file changed, 2 insertions(+)
+ 2 files changed, 13 insertions(+)
+ create mode 100644 CHANGELOG.md
  create mode 100644 Cargo.toml