♻ Adds licensing summary to docs folder (#49)

* Adds licensing summary to docs folder

* Review comments

* Update README.md

Co-Authored-By: Graham Hammond <graham.hammond@arm.com>

* Update README.md

* Update README.md

Co-Authored-By: Graham Hammond <graham.hammond@arm.com>

* Update README.md

Co-authored-by: Graham Hammond <graham.hammond@arm.com>

Author: acabarbaye

README.md

@@ -5,7 +5,9 @@
 [![PyPI](https://img.shields.io/pypi/v/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
 [![PyPI - Status](https://img.shields.io/pypi/status/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mbed-tools-ci-scripts)](https://pypi.org/project/mbed-tools-ci-scripts/)
+
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ARMmbed/mbed-tools-ci-scripts/blob/master/LICENSE)
+[![Compliance](https://badgen.net/badge/License%20Report/compliant/green?icon=libraries)](https://armmbed.github.io/mbed-tools-ci-scripts/third_party_IP_report.html)
 
 [![Build Status](https://dev.azure.com/mbed-tools/mbed-tools-ci-scripts/_apis/build/status/Build%20and%20Release?branchName=master&stageName=CI%20Checkpoint)](https://dev.azure.com/mbed-tools/mbed-tools-ci/_build/latest?definitionId=3&branchName=master)
 [![Test Coverage](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts/branch/master/graph/badge.svg)](https://codecov.io/gh/ARMmbed/mbed-tools-ci-scripts)

mbed_tools_ci_scripts/report_third_party_ip.py

@@ -24,23 +24,32 @@
 logger = logging.getLogger(__name__)
 
 
-def generate_spdx_reports(output_directory: Path) -> SpdxProject:
-    """Generates all the SPDX reports for the current project."""
+def get_current_spdx_project() -> SpdxProject:
+    """Gets information about the current project/package."""
     logger.info("Generating package information.")
     try:
         # Trying to generate the egg for the package but this may fail. If so, continue.
         generate_package_info()
     except Exception as e:
         log_exception(logger, e)
+    return SpdxProject(CurrentProjectMetadataParser())
 
+
+def generate_spdx_project_reports(project: SpdxProject, output_directory: Path) -> SpdxProject:
+    """Generates all the SPDX reports for a given project."""
     logger.info("Generating SPDX report.")
-    project = SpdxProject(CurrentProjectMetadataParser())
     project.generate_tag_value_files(output_directory)
     logger.info("Generating licensing summary.")
     project.generate_licensing_summary(output_directory)
     return project
 
 
+def generate_spdx_reports(output_directory: Path) -> SpdxProject:
+    """Generates all the SPDX reports for the current project."""
+    project = get_current_spdx_project()
+    return generate_spdx_project_reports(project, output_directory)
+
+
 def main() -> int:
     """Script CLI."""
     parser = argparse.ArgumentParser(description="Generate licence and third-party IP reports.")

mbed_tools_ci_scripts/tag_and_release.py

@@ -20,7 +20,11 @@
 from mbed_tools_ci_scripts.utils.filesystem_helpers import cd
 from mbed_tools_ci_scripts.utils.git_helpers import ProjectTempClone, GitWrapper
 from mbed_tools_ci_scripts.utils.logging import log_exception, set_log_level
-from mbed_tools_ci_scripts.report_third_party_ip import generate_spdx_reports
+from mbed_tools_ci_scripts.report_third_party_ip import (
+    get_current_spdx_project,
+    generate_spdx_project_reports,
+    SpdxProject,
+)
 
 ENVVAR_TWINE_USERNAME = "TWINE_USERNAME"
 ENVVAR_TWINE_PASSWORD = "TWINE_PASSWORD"
@@ -48,11 +52,14 @@ def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> N
         raise ValueError("Undefined version.")
     if mode == CommitType.DEVELOPMENT:
         return
+    # The documentation folder will be emptied when the documentation is updated
     _update_documentation()
+    # Adding the licensing summaries in /docs after folder has been cleared and regenerated.
+    spdx_project = _update_licensing_summary()
     add_licence_header(0)
     _update_repository(mode, is_new_version, version, current_branch)
     if is_new_version:
-        _generate_spdx_reports()
+        _generate_spdx_reports(spdx_project)
         _release_to_pypi()
 
 
@@ -73,6 +80,14 @@ def _update_documentation() -> None:
     generate_documentation(docs_dir, module_to_document)
 
 
+def _update_licensing_summary() -> SpdxProject:
+    project = get_current_spdx_project()
+    project.generate_licensing_summary(
+        Path(configuration.get_value(ConfigurationVariable.DOCUMENTATION_PRODUCTION_OUTPUT_PATH))
+    )
+    return project
+
+
 def _update_repository(mode: CommitType, is_new_version: bool, version: str, current_branch: Optional[str]) -> None:
     """Update repository with changes that happened."""
     with ProjectTempClone(desired_branch_name=current_branch) as git:
@@ -87,12 +102,12 @@ def _update_repository(mode: CommitType, is_new_version: bool, version: str, cur
             git.force_push_tag()
 
 
-def _generate_spdx_reports() -> None:
+def _generate_spdx_reports(project: SpdxProject) -> None:
     report_directory = Path(configuration.get_value(ConfigurationVariable.PROJECT_ROOT)).joinpath(
         SPDX_REPORTS_DIRECTORY
     )
     report_directory.mkdir(exist_ok=True)
-    generate_spdx_reports(report_directory)
+    generate_spdx_project_reports(project, report_directory)
 
 
 def _add_version_changes(git: GitWrapper) -> None:

news/20200423.feature

@@ -0,0 +1 @@
+Add licensing summary to docs.