Improve logging (#15)

Author: acabarbaye

azure-pipelines/build-release.yml

@@ -126,7 +126,7 @@ stages:
           - template: steps/install-development-dependencies.yml
 
           - script: |
-              cd-assert-news -b $(current_branch)
+              cd-assert-news -vv -b $(current_branch)
             displayName: 'Run check'
             env:
               GIT_TOKEN: $(GIT_TOKEN)

continuous_delivery_scripts/assert_news.py

@@ -93,7 +93,7 @@ def validate_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> None:
         validate_news_file(absolute_file_path)
 
 
-def add_news_files(git: GitWrapper, news_dir: str) -> None:
+def generate_news_file(git: GitWrapper, news_dir: str) -> pathlib.Path:
     """Adds a news file if the branch corresponds to an dependency update.
 
     Args:
@@ -109,19 +109,21 @@ def add_news_files(git: GitWrapper, news_dir: str) -> None:
     if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
         raise EnvironmentError(f"Branch {current_branch} must contain a news file.")
 
-    create_news_file(
+    message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
+        message=", ".join(groups)
+    )
+    logger.info(f"Generating a news file with content: {message}...")
+    return create_news_file(
         news_dir,
-        str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
-            message=", ".join(groups)
-        ),
+        message,
         configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
     )
 
 
-def _commit_news_file(git: GitWrapper, news_dir: str) -> None:
-    logger.info("Committing news file...")
+def _commit_news_file(git: GitWrapper, news_file: pathlib.Path) -> None:
+    logger.info(f"Committing news file {str(news_file)}...")
     git.configure_for_github()
-    git.add(news_dir)
+    git.add(str(news_file))
     git.commit("📰 Automatic changes ⚙ Adding news file")
     git.push()
     git.pull()
@@ -150,11 +152,11 @@ def main() -> None:
             except Exception as e:
                 log_exception(logger, e)
                 try:
-                    add_news_files(git, absolute_news_dir)
-                    _commit_news_file(git, absolute_news_dir)
+                    news_file = generate_news_file(git, absolute_news_dir)
+                    _commit_news_file(git, news_file)
                 except Exception as e2:
                     log_exception(logger, e2)
-                    sys.exit(1)
+                sys.exit(1)
 
 
 if __name__ == "__main__":

continuous_delivery_scripts/utils/news_file.py

@@ -5,9 +5,12 @@
 """Helpers with regards to news files."""
 import enum
 import pathlib
+import logging
 from datetime import datetime
 from typing import Any
 
+logger = logging.getLogger(__name__)
+
 
 class NewsType(enum.Enum):
     """Describes the type of news we're writing."""
@@ -44,6 +47,7 @@ def determine_news_file_path(news_dir: str, news_type: NewsType) -> pathlib.Path
 
 
 def _write_file(file_path: pathlib.Path, text: str) -> None:
+    logger.info(f"Writing news file: {file_path}")
     file_path.parent.mkdir(parents=True, exist_ok=True)
     if not text.endswith("\n"):
         text = f"{text}\n"

news/202108110106.bugfix

@@ -0,0 +1 @@
+Improved logging when creating and asserting news files