chore(logging): increase log verbosity (#1244)

* chore(logging): increase log verbosity in git-cliff/src/lib.rs

* chore(logging): increase log verbosity in git-cliff/src/lib.rs and git-cliff/src/profile.rs

* chore(logging): increase log verbosity in git-cliff-core/src/changelog.rs

* chore(logging): increase log verbosity in git-cliff-core/src/commit.rs

* chore(logging): increase log verbosity in git-cliff-core/src/config.rs

* chore(logging): increase log verbosity in git-cliff-core/src/lib.rs

* chore(logging): increase log verbosity in git-cliff-core/src/repo.rs

* chore(logging): increase log verbosity in git-cliff-core/src/remote/mod.rs

* chore(logging): increase log verbosity in git-cliff-core/src/statistics.rs

* chore(logging): increase log verbosity in git-cliff-core/src/template.rs

* ci: trigger actions

Signed-off-by: Shingo OKAWA <[email protected]>

* fix: address review feedback

Signed-off-by: Shingo OKAWA <[email protected]>

* fix: address review feedback

Signed-off-by: Shingo OKAWA <[email protected]>

* ci: trigger GitHub Actions workflow

Signed-off-by: Shingo OKAWA <[email protected]>

* fix: address review feedback

Signed-off-by: Shingo OKAWA <[email protected]>

---------

Signed-off-by: Shingo OKAWA <[email protected]>

Author: ognis1205

git-cliff-core/src/changelog.rs

@@ -88,12 +88,16 @@ impl<'a> Changelog<'a> {
         match commit.process(git_config) {
             Ok(commit) => Some(commit),
             Err(e) => {
-                trace!(
-                    "{} - {} ({})",
-                    commit.id.chars().take(7).collect::<String>(),
-                    e,
-                    commit.message.lines().next().unwrap_or_default().trim()
-                );
+                let short_id = commit.id.chars().take(7).collect::<String>();
+                let summary = commit.message.lines().next().unwrap_or_default().trim();
+                match &e {
+                    Error::ParseError(_) | Error::FieldError(_) => {
+                        log::warn!("{short_id} - {e} ({summary})");
+                    }
+                    _ => {
+                        log::trace!("{short_id} - {e} ({summary})");
+                    }
+                }
                 None
             }
         }
@@ -102,12 +106,11 @@ impl<'a> Changelog<'a> {
     /// Checks the commits and returns an error if any unconventional commits
     /// are found.
     fn check_conventional_commits(commits: &Vec<Commit<'a>>) -> Result<()> {
-        debug!("Verifying that all commits are conventional.");
+        log::debug!("Verifying that all commits are conventional");
         let mut unconventional_count = 0;
-
         commits.iter().for_each(|commit| {
             if commit.conv.is_none() {
-                error!(
+                log::error!(
                     "Commit {id} is not conventional:\n{message}",
                     id = &commit.id[..7],
                     message = commit
@@ -164,7 +167,7 @@ impl<'a> Changelog<'a> {
     /// Processes the commits and omits the ones that doesn't match the
     /// criteria set by configuration file.
     fn process_commits(&mut self) -> Result<()> {
-        debug!("Processing the commits...");
+        log::debug!("Processing the commits");
         for release in self.releases.iter_mut() {
             Self::process_commit_list(&mut release.commits, &self.config.git)?;
             for submodule_commits in release.submodule_commits.values_mut() {
@@ -176,7 +179,7 @@ impl<'a> Changelog<'a> {
 
     /// Processes the releases and filters them out based on the configuration.
     fn process_releases(&mut self) {
-        debug!("Processing {} release(s)...", self.releases.len());
+        log::debug!("Processing {} release(s)", self.releases.len());
         let skip_regex = self.config.git.skip_tags.as_ref();
         let mut skipped_tags = Vec::new();
         self.releases = self
@@ -188,13 +191,13 @@ impl<'a> Changelog<'a> {
                 if let Some(version) = &release.version {
                     if skip_regex.is_some_and(|r| r.is_match(version)) {
                         skipped_tags.push(version.clone());
-                        trace!("Skipping release: {}", version);
+                        log::debug!("Skipping release: {}", version);
                         return false;
                     }
                 }
                 if release.commits.is_empty() {
                     if let Some(version) = release.version.clone() {
-                        trace!("Release doesn't have any commits: {}", version);
+                        log::debug!("Release doesn't have any commits: {}", version);
                     }
                     match &release.previous {
                         Some(prev_release) if prev_release.commits.is_empty() => {
@@ -250,11 +253,8 @@ impl<'a> Changelog<'a> {
                 .map(|v| v.contains_variable(github::TEMPLATE_VARIABLES))
                 .unwrap_or(false)
         {
-            debug!(
-                "You are using an experimental feature! Please report bugs at <https://git-cliff.org/issues>"
-            );
             let github_client = GitHubClient::try_from(self.config.remote.github.clone())?;
-            info!(
+            log::info!(
                 "{} ({})",
                 github::START_FETCHING_MSG,
                 self.config.remote.github
@@ -267,11 +267,11 @@ impl<'a> Changelog<'a> {
                         github_client.get_commits(ref_name),
                         github_client.get_pull_requests(ref_name),
                     )?;
-                    debug!("Number of GitHub commits: {}", commits.len());
-                    debug!("Number of GitHub pull requests: {}", pull_requests.len());
+                    log::debug!("Number of GitHub commits: {}", commits.len());
+                    log::debug!("Number of GitHub pull requests: {}", pull_requests.len());
                     Ok((commits, pull_requests))
                 });
-            info!("{}", github::FINISHED_FETCHING_MSG);
+            log::info!("{}", github::FINISHED_FETCHING_MSG);
             data
         } else {
             Ok((vec![], vec![]))
@@ -304,11 +304,8 @@ impl<'a> Changelog<'a> {
                 .map(|v| v.contains_variable(gitlab::TEMPLATE_VARIABLES))
                 .unwrap_or(false)
         {
-            debug!(
-                "You are using an experimental feature! Please report bugs at <https://git-cliff.org/issues>"
-            );
             let gitlab_client = GitLabClient::try_from(self.config.remote.gitlab.clone())?;
-            info!(
+            log::info!(
                 "{} ({})",
                 gitlab::START_FETCHING_MSG,
                 self.config.remote.gitlab
@@ -321,7 +318,7 @@ impl<'a> Changelog<'a> {
                     let project_id = match tokio::join!(gitlab_client.get_project(ref_name)) {
                         (Ok(project),) => project.id,
                         (Err(err),) => {
-                            error!("Failed to lookup project! {}", err);
+                            log::error!("Failed to lookup project! {}", err);
                             return Err(err);
                         }
                     };
@@ -330,11 +327,11 @@ impl<'a> Changelog<'a> {
                         gitlab_client.get_commits(project_id, ref_name),
                         gitlab_client.get_merge_requests(project_id, ref_name),
                     )?;
-                    debug!("Number of GitLab commits: {}", commits.len());
-                    debug!("Number of GitLab merge requests: {}", merge_requests.len());
+                    log::debug!("Number of GitLab commits: {}", commits.len());
+                    log::debug!("Number of GitLab merge requests: {}", merge_requests.len());
                     Ok((commits, merge_requests))
                 });
-            info!("{}", gitlab::FINISHED_FETCHING_MSG);
+            log::info!("{}", gitlab::FINISHED_FETCHING_MSG);
             data
         } else {
             Ok((vec![], vec![]))
@@ -365,11 +362,8 @@ impl<'a> Changelog<'a> {
                 .map(|v| v.contains_variable(gitea::TEMPLATE_VARIABLES))
                 .unwrap_or(false)
         {
-            debug!(
-                "You are using an experimental feature! Please report bugs at <https://git-cliff.org/issues>"
-            );
             let gitea_client = GiteaClient::try_from(self.config.remote.gitea.clone())?;
-            info!(
+            log::info!(
                 "{} ({})",
                 gitea::START_FETCHING_MSG,
                 self.config.remote.gitea
@@ -382,11 +376,11 @@ impl<'a> Changelog<'a> {
                         gitea_client.get_commits(ref_name),
                         gitea_client.get_pull_requests(ref_name),
                     )?;
-                    debug!("Number of Gitea commits: {}", commits.len());
-                    debug!("Number of Gitea pull requests: {}", pull_requests.len());
+                    log::debug!("Number of Gitea commits: {}", commits.len());
+                    log::debug!("Number of Gitea pull requests: {}", pull_requests.len());
                     Ok((commits, pull_requests))
                 });
-            info!("{}", gitea::FINISHED_FETCHING_MSG);
+            log::info!("{}", gitea::FINISHED_FETCHING_MSG);
             data
         } else {
             Ok((vec![], vec![]))
@@ -422,11 +416,8 @@ impl<'a> Changelog<'a> {
                 .map(|v| v.contains_variable(bitbucket::TEMPLATE_VARIABLES))
                 .unwrap_or(false)
         {
-            debug!(
-                "You are using an experimental feature! Please report bugs at <https://git-cliff.org/issues>"
-            );
             let bitbucket_client = BitbucketClient::try_from(self.config.remote.bitbucket.clone())?;
-            info!(
+            log::info!(
                 "{} ({})",
                 bitbucket::START_FETCHING_MSG,
                 self.config.remote.bitbucket
@@ -439,11 +430,11 @@ impl<'a> Changelog<'a> {
                         bitbucket_client.get_commits(ref_name),
                         bitbucket_client.get_pull_requests(ref_name)
                     )?;
-                    debug!("Number of Bitbucket commits: {}", commits.len());
-                    debug!("Number of Bitbucket pull requests: {}", pull_requests.len());
+                    log::debug!("Number of Bitbucket commits: {}", commits.len());
+                    log::debug!("Number of Bitbucket pull requests: {}", pull_requests.len());
                     Ok((commits, pull_requests))
                 });
-            info!("{}", bitbucket::FINISHED_FETCHING_MSG);
+            log::info!("{}", bitbucket::FINISHED_FETCHING_MSG);
             data
         } else {
             Ok((vec![], vec![]))
@@ -462,7 +453,7 @@ impl<'a> Changelog<'a> {
     /// Adds remote data (e.g. GitHub commits) to the releases.
     #[allow(unused_variables)]
     pub fn add_remote_data(&mut self, range: Option<&str>) -> Result<()> {
-        debug!("Adding remote data...");
+        log::debug!("Adding remote data");
         self.add_remote_context()?;
 
         // Determine the ref at which to fetch remote commits, based on the commit
@@ -524,7 +515,7 @@ impl<'a> Changelog<'a> {
             if last_release.version.is_none() {
                 let next_version =
                     last_release.calculate_next_version_with_config(&self.config.bump)?;
-                debug!("Bumping the version to {next_version}");
+                log::debug!("Bumping the version to {next_version}");
                 last_release.version = Some(next_version.to_string());
                 last_release.timestamp = Some(
                     SystemTime::now()
@@ -540,7 +531,7 @@ impl<'a> Changelog<'a> {
 
     /// Generates the changelog and writes it to the given output.
     pub fn generate<W: Write + ?Sized>(&self, out: &mut W) -> Result<()> {
-        debug!("Generating changelog...");
+        log::debug!("Generating changelog");
         let postprocessors = self.config.changelog.postprocessors.clone();
 
         if let Some(header_template) = &self.header_template {
@@ -603,7 +594,7 @@ impl<'a> Changelog<'a> {
 
     /// Generates a changelog and prepends it to the given changelog.
     pub fn prepend<W: Write + ?Sized>(&self, mut changelog: String, out: &mut W) -> Result<()> {
-        debug!("Generating changelog and prepending...");
+        log::debug!("Generating changelog and prepending");
         if let Some(header) = &self.config.changelog.header {
             changelog = changelog.replacen(header, "", 1);
         }
@@ -632,7 +623,7 @@ fn get_body_template(config: &Config, trim: bool) -> Result<Template> {
         "commit.bitbucket",
     ];
     if template.contains_variable(&deprecated_vars) {
-        warn!(
+        log::warn!(
             "Variables {deprecated_vars:?} are deprecated and will be removed in the future. Use \
              `commit.remote` instead."
         );

git-cliff-core/src/commit.rs

@@ -327,7 +327,7 @@ impl Commit<'_> {
                 match values {
                     Some(values) => {
                         if values.is_empty() {
-                            trace!("field '{field_name}' is present but empty");
+                            log::trace!("Field '{field_name}' is present but empty");
                         } else {
                             for value in values {
                                 regex_checks.push((pattern_regex, value));

git-cliff-core/src/config.rs

@@ -354,10 +354,10 @@ impl Bump {
     /// This function also logs the returned value.
     pub fn get_initial_tag(&self) -> String {
         if let Some(tag) = self.initial_tag.clone() {
-            warn!("No releases found, using initial tag '{tag}' as the next version.");
+            log::warn!("No releases found, using initial tag '{tag}' as the next version");
             tag
         } else {
-            warn!("No releases found, using {DEFAULT_INITIAL_TAG} as the next version.");
+            log::warn!("No releases found, using {DEFAULT_INITIAL_TAG} as the next version");
             DEFAULT_INITIAL_TAG.into()
         }
     }
@@ -499,7 +499,7 @@ impl Config {
         .filter_map(|v| v.as_ref())
         {
             if supported_path.exists() {
-                debug!("Using configuration file from: {:?}", supported_path);
+                log::debug!("Using configuration file from: {:?}", supported_path);
                 return Some(supported_path.to_path_buf());
             }
         }

git-cliff-core/src/error.rs

@@ -33,7 +33,7 @@ pub enum Error {
     LoggerError(String),
     /// When commit's not follow the conventional commit structure we throw this
     /// error.
-    #[error("Cannot parse the commit: `{0}`")]
+    #[error("Commit did not match conventional format: `{0}`")]
     ParseError(#[from] git_conventional::Error),
     /// Error that may occur while grouping commits.
     #[error("Grouping error: `{0}`")]

git-cliff-core/src/lib.rs

@@ -42,9 +42,6 @@ pub mod tag;
 /// Template engine.
 pub mod template;
 
-#[macro_use]
-extern crate log;
-
 /// Default configuration file.
 pub const DEFAULT_CONFIG: &str = "cliff.toml";
 /// Default output file.

git-cliff-core/src/remote/mod.rs

@@ -190,15 +190,15 @@ pub trait RemoteClient {
         page: i32,
     ) -> Result<T> {
         let url = T::url(project_id, &self.api_url(), &self.remote(), ref_name, page);
-        debug!("Sending request to: {url}");
+        log::debug!("Sending request to: {url}");
         let response = self.client().get(&url).send().await?;
         let response_text = if response.status().is_success() {
             let text = response.text().await?;
-            trace!("Response: {:?}", text);
+            log::trace!("Response: {:?}", text);
             text
         } else {
             let text = response.text().await?;
-            error!("Request error: {}", text);
+            log::error!("Request error: {}", text);
             text
         };
         Ok(serde_json::from_str::<T>(&response_text)?)
@@ -212,15 +212,15 @@ pub trait RemoteClient {
         page: i32,
     ) -> Result<Vec<T>> {
         let url = T::url(project_id, &self.api_url(), &self.remote(), ref_name, page);
-        debug!("Sending request to: {url}");
+        log::debug!("Sending request to: {url}");
         let response = self.client().get(&url).send().await?;
         let response_text = if response.status().is_success() {
             let text = response.text().await?;
-            trace!("Response: {:?}", text);
+            log::trace!("Response: {:?}", text);
             text
         } else {
             let text = response.text().await?;
-            error!("Request error: {}", text);
+            log::error!("Request error: {}", text);
             text
         };
         let response = serde_json::from_str::<Vec<T>>(&response_text)?;
@@ -244,7 +244,7 @@ pub trait RemoteClient {
             .buffered(T::buffer_size())
             .take_while(|page| {
                 if let Err(e) = page {
-                    debug!("Error while fetching page: {:?}", e);
+                    log::debug!("Error while fetching page: {:?}", e);
                 }
                 future::ready(page.is_ok())
             })
@@ -275,7 +275,7 @@ pub trait RemoteClient {
                 let status = match page {
                     Ok(v) => !self.early_exit(v),
                     Err(e) => {
-                        debug!("Error while fetching page: {:?}", e);
+                        log::debug!("Error while fetching page: {:?}", e);
                         true
                     }
                 };

git-cliff-core/src/repo.rs

@@ -189,7 +189,7 @@ impl Repository {
                 // submodule updated
                 Some(format!("{}..{}", old_file_id, new_file_id))
             };
-            trace!("Release commit range for submodules: {:?}", range);
+            log::trace!("Release commit range for submodules: {:?}", range);
             delta.new_file().path().and_then(Path::to_str).zip(range)
         });
         // iterate through all path diffs and find corresponding submodule if
@@ -305,11 +305,11 @@ impl Repository {
                     cache_key,
                     v,
                 ) {
-                    error!("Failed to set cache for repo {:?}: {e}", self.path);
+                    log::error!("Failed to set cache for repo {:?}: {e}", self.path);
                 }
             }
             Err(e) => {
-                error!("Failed to serialize cache for repo {:?}: {e}", self.path);
+                log::error!("Failed to serialize cache for repo {:?}: {e}", self.path);
             }
         }
 
@@ -500,7 +500,7 @@ impl Repository {
                     .url()
                     .ok_or_else(|| Error::RepoError(String::from("failed to get the remote URL")))?
                     .to_string();
-                trace!("Upstream URL: {url}");
+                log::trace!("Upstream URL: {url}");
                 return find_remote(&url);
             }
         }

git-cliff-core/src/statistics.rs

@@ -52,8 +52,8 @@ impl From<&Release<'_>> for Statistics {
     fn from(release: &Release) -> Self {
         let commit_count = release.commits.len();
         let commits_timespan = if release.commits.len() < 2 {
-            trace!(
-                "commits_timespan: insufficient commits to calculate duration (found {})",
+            log::trace!(
+                "Insufficient commits to calculate duration (found {})",
                 release.commits.len()
             );
             None
@@ -105,7 +105,7 @@ impl From<&Release<'_>> for Statistics {
                 )
                 .map(|(curr, prev)| (curr.date_naive() - prev.date_naive()).num_days()),
             None => {
-                trace!("days_passed_since_last_release: previous release not found");
+                log::trace!("Previous release not found");
                 None
             }
         };