diff --git a/README.md b/README.md index 8a43a49..6c66b96 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ See the default action step definition: "projects-title-filter": ["Community Outreach Initiatives", "CDD Project"] } ]' - ``` +``` See the full example of action step definition (in example are used non-default values): @@ -534,14 +534,14 @@ All done! ✨ 🍰 ✨ ## Run Unit Test Unit tests are written using Pytest framework. To run alle the tests, use the following command: -```bash +```shell pytest tests/ ``` You can modify the directory to control the level of detail or granularity as per your needs. To run specific test, write the command following the pattern below: -```bash +```shell pytest tests/utils/test_utils.py::test_make_issue_key ``` @@ -551,14 +551,14 @@ This project uses [pytest-cov](https://pypi.org/project/pytest-cov/) plugin to g The objective of the project is to achieve a minimal score of 80 %. We do exclude the `tests/` file from the coverage report. To generate the coverage report, run the following command: -```bash +```shell pytest --cov=. tests/ --cov-fail-under=80 --cov-report=html ``` See the coverage report on the path: -``` -htmlcov/index.html +```shell +open htmlcov/index.html ``` ## Deployment diff --git a/living_documentation_generator/model/consolidated_issue.py b/living_documentation_generator/model/consolidated_issue.py index d5a5592..b5cbf14 100644 --- a/living_documentation_generator/model/consolidated_issue.py +++ b/living_documentation_generator/model/consolidated_issue.py @@ -199,6 +199,7 @@ def generate_directory_path(self, issue_table: str) -> list[str]: # If no label ends with "Topic", create a "NoTopic" issue directory path if not topic_labels: self.__topics = ["NoTopic"] + logger.error("No Topic label found for Issue #%s: %s (%s)", self.number, self.title, self.repository_id) no_topic_path = os.path.join(output_path, "NoTopic") return [no_topic_path]