Merge pull request #1 from ARMmbed/plugins

language plugins

Author: acabarbaye

Pipfile

@@ -17,7 +17,6 @@ pyfakefs = "*"
 pytest-cov = "*"
 wheel = "*"
 continuous-delivery-scripts = {editable = true, path = "."}
-mbed-tools-ci-scripts = "*"
 pre-commit = "*"
 
 [pipenv]

azure-pipelines/build-release.yml

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

azure-pipelines/steps/generate-documentation.yml

@@ -1,12 +1,12 @@
 steps:
   - bash: |
-      echo "##vso[task.setvariable variable=temp_docs_path]`get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH`"
+      echo "##vso[task.setvariable variable=temp_docs_path]`cd-get-config --key DOCUMENTATION_PRODUCTION_OUTPUT_PATH`"
     displayName: 'Set variable for temporary docs dir'
 
   - script: |
-      generate-docs --output_dir $(temp_docs_path)
+      cd-generate-docs --output_dir $(temp_docs_path)
     displayName: 'Generate documentation'
 
   - script: |
-      license-files
+      cd-license-files
     displayName: 'Add copyright/licence notice.'

azure-pipelines/steps/generate-spdx-documents.yml

@@ -5,11 +5,11 @@ steps:
 
   - bash: |
       mkdir -p $(temp_spdx_reports_path)
-      generate-spdx --output-dir $(temp_spdx_reports_path)
+      cd-generate-spdx --output-dir $(temp_spdx_reports_path)
     displayName: 'Generate SPDX documents'
 
   - script: |
-      license-files
+      cd-license-files
     displayName: 'Add copyright/licence notice.'
 
   - publish: $(temp_spdx_reports_path)

azure-pipelines/steps/tag-and-release.yml

@@ -4,7 +4,7 @@ parameters:
   currentBranch: ''
 
 steps:
-  - bash: tag-and-release -b ${{ parameters.currentBranch }} --release-type=${{ parameters.releaseType }} -vv
+  - bash: cd-tag-and-release -b ${{ parameters.currentBranch }} --release-type=${{ parameters.releaseType }} -vv
     displayName: ${{ parameters.message }}
     env:
       GIT_TOKEN: $(GIT_TOKEN)

continuous_delivery_scripts/__init__.py

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 """Scripts and utilities used by the CI pipeline."""

continuous_delivery_scripts/_version.py

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 """The version number is based on semantic versioning.

continuous_delivery_scripts/assert_news.py

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 """Checks if valid news files are created for changes in the project."""

continuous_delivery_scripts/create_news_file.py

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
 """Easy news files generation.
@@ -61,7 +61,7 @@ def _write_file(file_path: pathlib.Path, text: str) -> None:
 
 
 def _determine_todays_news_file_name() -> str:
-    return datetime.now().strftime("%Y%m%d%H%M%S")
+    return datetime.now().strftime("%Y%m%d%H%M")
 
 
 def main() -> int:

continuous_delivery_scripts/generate_docs.py

@@ -1,20 +1,17 @@
 #
-# Copyright (C) 2020 Arm Mbed. All rights reserved.
+# Copyright (C) 2020 Arm. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
-"""Generates documentation using Pdoc."""
+"""Generates documentation."""
+import argparse
+import logging
 import os
 import shutil
 import sys
-
-import argparse
-import logging
 from pathlib import Path
-from subprocess import check_call
-from typing import List
 
+from continuous_delivery_scripts.language_specifics import get_language_specifics
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
-from continuous_delivery_scripts.utils.filesystem_helpers import TemporaryDirectory
 from continuous_delivery_scripts.utils.logging import log_exception
 
 logger = logging.getLogger(__name__)
@@ -26,40 +23,11 @@ def _clear_previous_docs(output_directory: Path) -> None:
         shutil.rmtree(str(output_directory))
 
 
-def _generate_pdoc_command_list(output_directory: Path, module: str) -> List[str]:
-    return [
-        "pdoc",
-        "--html",
-        f"{module}",
-        "--output-dir",
-        f"{str(output_directory)}",
-        "--force",
-        "--config",
-        "show_type_annotations=True",
-    ]
-
-
 def generate_documentation(output_directory: Path, module_to_document: str) -> None:
-    """Ensures the documentation is in the correct location.
-
-    Pdoc nests its docs output in a folder with the module's name.
-    This process removes this unwanted folder.
-    """
+    """Generates the documentation."""
     _clear_previous_docs(output_directory)
     os.makedirs(str(output_directory), exist_ok=True)
-    with TemporaryDirectory() as temp_dir:
-        _call_pdoc(temp_dir, module_to_document)
-        docs_contents_dir = temp_dir.joinpath(module_to_document)
-        if docs_contents_dir.exists() and docs_contents_dir.is_dir():
-            for element in docs_contents_dir.iterdir():
-                shutil.move(str(element), str(output_directory))
-
-
-def _call_pdoc(output_directory: Path, module: str) -> None:
-    """Calls Pdoc for generating the docs."""
-    logger.info("Creating Pdoc documentation.")
-    command_list = _generate_pdoc_command_list(output_directory, module)
-    check_call(command_list)
+    get_language_specifics().generate_code_documentation(output_directory, module_to_document)
 
 
 def generate_docs(output_directory: Path, module: str) -> int: