feat(cli): Commit and push changelog entry after adding

.clconfig.json

@@ -15,9 +15,10 @@
     "Features": "feat",
     "Improvements": "imp"
   },
+  "commit_message": "add changelog entry",
   "expected_spellings": {
     "CLI": "cli"
   },
   "legacy_version": null,
   "target_repo": "https://github.com/MalteHerrmann/changelog-utils"
-}
+}

CHANGELOG.md

@@ -17,6 +17,7 @@ This changelog was created using the `clu` binary
 
 ### Features
 
+- (cli) [#68](https://github.com/MalteHerrmann/changelog-utils/pull/68) Commit and push changelog entry after adding.
 - (cli) [#67](https://github.com/MalteHerrmann/changelog-utils/pull/67) Add option to push branch to remote.
 - (cli) [#63](https://github.com/MalteHerrmann/changelog-utils/pull/63) Enable switching between release types when not specifying a version.
 

src/add.rs

@@ -1,12 +1,17 @@
 use crate::{
     change_type, changelog, config, entry,
     errors::AddError,
-    github::{extract_pr_info, get_git_info, get_open_pr, PRInfo},
+    github::{commit, extract_pr_info, get_git_info, get_open_pr, PRInfo},
     inputs, release,
 };
 use std::borrow::BorrowMut;
 
 // Runs the logic to add an entry to the unreleased section of the changelog.
+//
+// After adding the new entry, the user is queried for a commit message to use
+// to commit the changes.
+//
+// NOTE: the changes are NOT pushed to the origin when running the `add` command.
 pub async fn run(accept: bool) -> Result<(), AddError> {
     let config = config::load()?;
     let git_info = get_git_info(&config)?;
@@ -68,7 +73,10 @@ pub async fn run(accept: bool) -> Result<(), AddError> {
         pr_number,
     );
 
-    Ok(changelog.write(&changelog.path)?)
+    changelog.write(&changelog.path)?;
+
+    let cm = inputs::get_commit_message(&config)?;
+    Ok(commit(cm.as_str())?)
 }
 
 /// Adds the given contents into a new entry in the unreleased section

src/config.rs

@@ -16,6 +16,9 @@ pub struct Config {
     /// an abbreviation that is to be used as a short form
     /// in pull request titles.
     pub change_types: BTreeMap<String, String>,
+    /// The default commit message to be used when committing
+    /// the new changelog entry.
+    pub commit_message: String,
     /// The map of expected spellings.
     ///
     /// Note: The key is the correct spelling and the value
@@ -56,9 +59,12 @@ impl Default for Config {
         default_change_types.insert("Features".into(), "feat".into());
         default_change_types.insert("Improvements".into(), "imp".into());
 
+        let commit_message = "add changelog entry".to_string();
+
         Config {
             categories: Vec::default(),
             change_types: default_change_types,
+            commit_message,
             expected_spellings: BTreeMap::default(),
             legacy_version: None,
             target_repo: String::default(),

src/create_pr.rs

@@ -50,5 +50,6 @@ pub async fn run() -> Result<(), CreateError> {
             .expect("received no error creating the PR but html_url was None")
     );
 
-    Ok(())
+    let cm = inputs::get_commit_message(&config)?;
+    Ok(github::commit_and_push(&cm)?)
 }

src/errors.rs

@@ -118,6 +118,8 @@ pub enum EntryError {
 pub enum GitHubError {
     #[error("failed to get current branch")]
     CurrentBranch,
+    #[error("failed to commit changes")]
+    FailedToCommit,
     #[error("failed to push to origin")]
     FailedToPush,
     #[error("failed to call GitHub API: {0}")]

src/github.rs

@@ -119,6 +119,61 @@ fn get_current_local_branch() -> Result<String, GitHubError> {
     }
 }
 
+/// Commits the current changes with the given commit message and pushes to the origin.
+pub fn commit_and_push(message: &str) -> Result<(), GitHubError> {
+    stage_changelog_changes()?;
+
+    match Command::new("git")
+        .args(vec!["commit", "-a", "-m", message])
+        .status()?
+        .success()
+    {
+        true => Ok(push()?),
+        false => Err(GitHubError::FailedToCommit),
+    }
+}
+
+/// Commits the current changes with the given commit message and pushes to the origin.
+pub fn commit(message: &str) -> Result<(), GitHubError> {
+    stage_changelog_changes()?;
+
+    if !Command::new("git")
+        .args(vec!["commit", "-m", message])
+        .status()?
+        .success()
+    {
+        return Err(GitHubError::FailedToCommit);
+    }
+
+    Ok(())
+}
+
+/// Adds the changelog to the staged changes in Git.
+fn stage_changelog_changes() -> Result<(), GitHubError> {
+    // TODO: pass the changelog filename / path
+    if !Command::new("git")
+        .args(vec!["add", "CHANGELOG.md"])
+        .status()?
+        .success()
+    {
+        return Err(GitHubError::FailedToCommit)
+    }
+
+    Ok(())
+}
+
+/// Tries to push the latest commits on the current branch.
+pub fn push() -> Result<(), GitHubError> {
+    match Command::new("git")
+        .args(vec!["push"])
+        .status()?
+        .success()
+    {
+        true => Ok(()),
+        false => Err(GitHubError::FailedToPush),
+    }
+}
+
 /// Tries to push the current branch to the origin repository.
 pub fn push_to_origin(branch_name: &str) -> Result<(), GitHubError> {
     match Command::new("git")

src/inputs.rs

@@ -30,6 +30,14 @@ pub fn get_category(config: &Config, default_idx: usize) -> Result<String, Input
     .prompt()?)
 }
 
+pub fn get_commit_message(config: &Config) -> Result<String, InputError> {
+    Ok(
+        Text::new("Please provide the commit message:\n")
+            .with_initial_value(config.commit_message.as_str())
+            .prompt()?
+    )
+}
+
 pub fn get_description(default_value: &str) -> Result<String, InputError> {
     Ok(
         Text::new("Please provide a one-line description of the made changes:\n")

src/testdata/example_config.json

@@ -5,6 +5,7 @@
     "Improvements": "imp",
     "Features": "feat"
   },
+  "commit_message": "add changelog entry",
   "expected_spellings": {
     "API": "api",
     "CLI": "cli",

src/testdata/example_config_without_optionals.json

@@ -5,10 +5,11 @@
     "Improvements": "imp",
     "Features": "feat"
   },
+  "commit_message": "add changelog entry",
   "expected_spellings": {
     "API": "api",
     "CLI": "cli",
     "Web-SDK": "web[-\\s]*sdk"
   },
   "target_repo": "https://github.com/MalteHerrmann/changelog-utils"
-}
+}

tests/testdata/evmos_config.json

@@ -21,6 +21,7 @@
     "State Machine Breaking": "imp",
     "API Breaking": "imp"
   },
+  "commit_message": "add changelog entry",
   "expected_spellings": {
     "ABI": "abi",
     "EIP-712": "eip[-\\s]*712"