✨ Added github_actions plugin (#60)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

Added `github_actions` plugin



### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [ ]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [x] Additional tests are not required for this change (e.g.
documentation update).

Author: acabarbaye

.secrets.baseline

@@ -107,7 +107,7 @@
         "filename": "continuous_delivery_scripts/plugins/python.py",
         "hashed_secret": "a5c8a5463c338b832f4afbe616ae77b4ecbfadc0",
         "is_verified": false,
-        "line_number": 26
+        "line_number": 27
       }
     ],
     "continuous_delivery_scripts/utils/git_helpers.py": [
@@ -425,5 +425,5 @@
       }
     ]
   },
-  "generated_at": "2022-11-30T17:07:25Z"
+  "generated_at": "2022-12-21T20:50:40Z"
 }

continuous_delivery_scripts/plugins/GITHUB_ACTIONS.MD

@@ -0,0 +1,14 @@
+# Github Actions configuration plugin
+
+This plugin is used for [GitHub Actions](https://github.com/features/actions) configuration projects when `PROGRAMMING_LANGUAGE` is set to `github_actions`.
+
+This plugin is dedicated to managing GitHub Actions and workflows and is expected to run within this CI system.
+
+## Prerequisites
+This plugin expects the [GitHub CLI](https://cli.github.com) to be installed and available from the path. 
+
+## Release
+The plugin carries out the same git actions as the [CI](./CI.MD) plugin but also performs extra GitHub actions such as release creation, etc.
+
+## Documentation
+The plugin does not generate any documentation.

continuous_delivery_scripts/plugins/ci.py

@@ -9,6 +9,7 @@
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 
@@ -18,10 +19,9 @@
 class CI(BaseLanguage):
     """Specific actions for a CI project."""
 
-    def package_software(self, version: str) -> None:
-        """No operation."""
-        super().package_software(version)
-        # Nothing to do
+    def package_software(self, mode: CommitType, version: str) -> None:
+        """Nothing to do."""
+        pass
 
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:
         """Generates the code documentation."""
@@ -37,9 +37,9 @@ def get_version_tag(self, version: str):
         cleansed_version = version.strip().lstrip("v")
         return f"v{cleansed_version}"
 
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """No operation."""
-        super().release_package_to_repository(version)
+        pass
 
     def check_credentials(self) -> None:
         """Checks any credentials."""

continuous_delivery_scripts/plugins/docker.py

@@ -7,6 +7,7 @@
 from pathlib import Path
 from typing import Optional
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
@@ -19,13 +20,13 @@ def get_related_language(self) -> str:
         """Gets the related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self, version: str) -> None:
+    def package_software(self, mode: CommitType, version: str) -> None:
         """Todo build docker image."""
-        super().package_software(version)
+        super().package_software(mode, version)
 
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """Todo push image to repository e.g. ecr, artifactory."""
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
 
     def check_credentials(self) -> None:
         """Checks any credentials."""

continuous_delivery_scripts/plugins/github_actions.py

@@ -0,0 +1,87 @@
+#
+# Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+"""Plugin for CI projects."""
+import logging
+import os
+from pathlib import Path
+from subprocess import check_call
+from typing import List
+
+from continuous_delivery_scripts.plugins.ci import CI
+from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
+from continuous_delivery_scripts.utils.language_specifics_base import get_language_from_file_name
+
+logger = logging.getLogger(__name__)
+ENVVAR_GITHUB_CLI_GIT_TOKEN = "GITHUB_TOKEN"
+
+
+def _generate_github_cli_release_command_list(
+    changelog: Path, version: str, tag: str, is_latest: bool, is_prerelease: bool
+) -> List[str]:
+    cmd = [
+        "ght",
+        "release",
+        "--latest",
+        "--notes-file",
+        f"{str(changelog)}",
+    ]
+    title = f":sparkles: Release {version}"
+    if is_latest:
+        cmd.append("--latest")
+    if is_prerelease:
+        cmd.append("--prerelease")
+        title = f":news: Pre-release {version}"
+    cmd.append("--title")
+    cmd.append(title)
+    cmd.append(tag)
+    return cmd
+
+
+def _generate_github_cli_check_command_list() -> List[str]:
+    return [
+        "gh",
+        "--version",
+    ]
+
+
+def _call_github_cli_check() -> None:
+    """Calls gh to verify its accessibility."""
+    logger.info("Checking GitHub Actions is correctly installed.")
+    env = os.environ
+    env[ENVVAR_GITHUB_CLI_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
+    check_call(_generate_github_cli_check_command_list(), env=env)
+
+
+class GitHubActions(CI):
+    """Specific actions for a GitHub Action project."""
+
+    def package_software(self, mode: CommitType, version: str) -> None:
+        """No operation."""
+        super().package_software(mode, version)
+        _call_github_cli_check()
+
+    def get_related_language(self) -> str:
+        """Gets the related language."""
+        return get_language_from_file_name(__file__)
+
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
+        """No operation."""
+        super().release_package_to_repository(mode, version)
+        is_latest = mode == CommitType.RELEASE
+        is_prerelease = mode == CommitType.BETA
+        self._call_github_cli_release(version, is_latest, is_prerelease)
+
+    def _call_github_cli_release(self, version: str, is_latest: bool, is_prerelease: bool) -> None:
+        """Calls github cli to create a release."""
+        tag = self.get_version_tag(version)
+        logger.info(f"Create a GitHub Release {version}")
+        changelogPath = configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH)
+        env = os.environ
+        env[ENVVAR_GITHUB_CLI_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
+
+        check_call(
+            _generate_github_cli_release_command_list(changelogPath, version, tag, is_latest, is_prerelease), env=env
+        )

continuous_delivery_scripts/plugins/golang.py

@@ -11,6 +11,7 @@
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository, GitWrapper
 
 logger = logging.getLogger(__name__)
@@ -124,14 +125,14 @@ def get_version_tag(self, version: str):
         cleansed_version = version.strip().lstrip("v")
         return f"v{cleansed_version}"
 
-    def package_software(self, version: str) -> None:
+    def package_software(self, mode: CommitType, version: str) -> None:
         """No operation."""
         super().package_software(version)
         _call_goreleaser_check(version)
 
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """No operation."""
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
         self._call_goreleaser_release(version)
 
     def check_credentials(self) -> None:

continuous_delivery_scripts/plugins/noop.py

@@ -7,6 +7,7 @@
 from pathlib import Path
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from typing import Optional
 
@@ -20,13 +21,13 @@ def get_related_language(self) -> str:
         """Gets the related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self, version: str) -> None:
+    def package_software(self, mode: CommitType, version: str) -> None:
         """No Op."""
-        super().package_software(version)
+        super().package_software(mode, version)
 
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """No Op."""
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
 
     def check_credentials(self) -> None:
         """No Op."""

continuous_delivery_scripts/plugins/python.py

@@ -14,6 +14,7 @@
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.filesystem_helpers import TemporaryDirectory
 from continuous_delivery_scripts.utils.filesystem_helpers import cd
 from continuous_delivery_scripts.utils.logging import log_exception
@@ -134,14 +135,14 @@ def get_related_language(self) -> str:
         """Gets related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self, version: str) -> None:
+    def package_software(self, mode: CommitType, version: str) -> None:
         """Packages the software into a wheel."""
-        super().package_software(version)
+        super().package_software(mode, version)
         _create_wheel()
 
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """Releases to PyPI."""
-        super().release_package_to_repository(version)
+        super().release_package_to_repository(mode, version)
         _release_to_pypi()
 
     def check_credentials(self) -> None:

continuous_delivery_scripts/tag_and_release.py

@@ -55,8 +55,8 @@ def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> N
             _clean_repository()
         if spdx_project and get_language_specifics().should_include_spdx_in_package():
             _generate_spdx_reports(spdx_project)
-        get_language_specifics().package_software(version)
-        get_language_specifics().release_package_to_repository(version)
+        get_language_specifics().package_software(mode, version)
+        get_language_specifics().release_package_to_repository(mode, version)
 
 
 def _get_documentation_config() -> Tuple[Path, str]:

continuous_delivery_scripts/utils/language_specifics_base.py

@@ -11,6 +11,7 @@
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 
 logger = logging.getLogger(__name__)
@@ -91,13 +92,18 @@ def generate_code_documentation(self, output_directory: Path, module_to_document
         pass
 
     @abstractmethod
-    def package_software(self, version: str) -> None:
+    def package_software(self, mode: CommitType, version: str) -> None:
         """Package the software so that it can get released."""
-        logger.info(f"Generating a release package [{version}]")
+        if mode == CommitType.RELEASE:
+            logger.info(f"Generating a release package [{version}]")
+        elif mode == CommitType.BETA:
+            logger.info(f"Generating a pre-release package [{version}]")
+        else:
+            logger.info(f"Generating a development package [{version}]")
         pass
 
     @abstractmethod
-    def release_package_to_repository(self, version: str) -> None:
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """Release the package to the official software repository."""
         logger.info(f"Uploading the package [{version}]")
         pass