Merge pull request #12 from ferreteleco/feature/upgrade-hooks

Feature/upgrade hooks

Author: ferreteleco

CHANGELOG.md

@@ -24,6 +24,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 -
 
+## [**1.2.1**] - 2023-03-13
+
+### Added
+
+-
+
+### Changed
+
+- Improved post gen. hooks, now tells to look for the checklist associated with each action.
+- Improved existing documentation to reflect changes and better explain functionality.
+
+### Fixed
+
+- Minor errors in C++ CI UT template.
+
 ## [**1.1.0**] - 2023-03-13
 
 ### Added

README.md

@@ -4,7 +4,7 @@ This repository can be used for adding Github Actions and templates to an existi
 
 ## Version
 
-Current version is 1.2.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Current version is 1.2.1 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Project's version should be updated, when applicable:
 
@@ -23,16 +23,16 @@ $ cookiecutter https://github.com/ferreteleco/cookie-github.git
 It will create the appropriate .github folder in your project directory (wherever you invoke
 cookiecutter).
 
-NOTE: it can also be cloned using GIT over SSH, if properly configured in your account.
+**NOTE:** it can also be cloned using GIT over SSH, if properly configured in your account.
 
-NOTE1: after the repository is downloaded, the template can be used again without downloading it
+**NOTE:** after the repository is downloaded, the template can be used again without downloading it
 again. In order to do so, simply specify template name as argument for cookiecutter:
 
 ```bash
 $ cookiecutter cookie-github
 ```
 
-NOTE: alternatively, you can use [Cookieninja](https://github.com/cookieninja-generator/cookieninja),
+**NOTE:** alternatively, you can use [Cookieninja](https://github.com/cookieninja-generator/cookieninja),
 forked and more updated version of Cookiecutter with backward compatibility.
 
 ## Variables
@@ -53,6 +53,9 @@ you will be prompted to fill in the following values:
       project built with Poetry.
     - other, which does not generate any action.
 
+**NOTE:** Each added action will be accompanied of a markdown checklist, stating the changes /
+configuration required to fine tune it.
+
 ## Contributing
 
 If you want to contribute to this template, feel free to do so! Create a new branch to work in, and

hooks/post_gen_project.py

@@ -5,6 +5,20 @@
 from shutil import rmtree, copytree
 
 
+class color:
+    """Simple colors for print without external libraries."""
+    PURPLE = '\033[95m'
+    CYAN = '\033[96m'
+    DARK_CYAN = '\033[36m'
+    BLUE = '\033[94m'
+    GREEN = '\033[92m'
+    YELLOW = '\033[93m'
+    RED = '\033[91m'
+    BOLD = '\033[1m'
+    UNDERLINE = '\033[4m'
+    END = '\033[0m'
+
+
 def change_line_endings_crlf_to_lf():
     for path in Path(".").glob("**/*"):
         if path.is_file():
@@ -31,20 +45,27 @@ def add_ci_action_unit_tests_runner():
 
     target_language = "{{cookiecutter.project_language}}"
 
-    if {{cookiecutter.add_ci_action_unit_tests_runner}} and target_language.lower() != "other":
+    if {{cookiecutter.add_ci_action_unit_tests_runner}}:
+
+        if target_language.lower() != "other":
+
+            LOG.info("Adding action for running unit tests (workflows folder) with default config...")
 
-        LOG.info("Adding action for running unit tests (workflows folder) with default config...")
+            destination = Path("workflows")
+            ci_test_workflow_files_path = Path("_", "workflows", target_language)
+            copytree(ci_test_workflow_files_path, destination)
 
-        destination = Path("workflows")
-        ci_test_workflow_files_path = Path("_", "workflows", target_language)
-        copytree(ci_test_workflow_files_path, destination)
+            print("\n\n######################################################################")
+            print("#                                                                    #")
+            print(f"# {color.BOLD}{color.BLUE}Please review gen. checklist in order to adjust CI UT basic action{color.END} #")
+            print("#                                                                    #")
+            print("######################################################################\n\n")
 
-        print("\n\n#################################################################")
-        print("# Please check gen. checklist in order to adjust CI UT basic action #")
-        print("#################################################################\n\n")
+        else:
+            LOG.info("CI action for running unit tests file generation is not defined for %s language. Skipping...", target_language)
 
     else:
-        LOG.info("Skipping CI action for running unit tests file generation (%s language selected) ...", target_language)
+        LOG.info("Skipping CI action for running unit tests file generation")
 
 
 def clean():