style: apply component guidelines

.gitlab-ci.yml

@@ -10,7 +10,7 @@ include:
     file: '/templates/validation.yml'
   - project: 'to-be-continuous/bash'
     ref: '3.3'
-    file: 'templates/gitlab-ci-bash.yml'
+    file: '/templates/gitlab-ci-bash.yml'
   - project: 'to-be-continuous/semantic-release'
     ref: '3.7'
     file: '/templates/gitlab-ci-semrel.yml'

README.md

@@ -444,7 +444,7 @@ Then you may retrieve any of your secret(s) from Vault using the following synta
 
 With:
 
-| Name                             | Description                            |
+| Parameter                        | Description                            |
 | -------------------------------- | -------------------------------------- |
 | `secret_path` (_path parameter_) | this is your secret location in the Vault server |
 | `field` (_query parameter_)      | parameter to access a single basic field from the secret JSON payload |

kicker.json

@@ -3,6 +3,8 @@
   "description": "Build, test and analyse your [Python](https://www.python.org/) projects",
   "template_path": "templates/gitlab-ci-python.yml",
   "kind": "build",
+  "prefix": "python",
+  "is_component": true,
   "variables": [
     {
       "name": "PYTHON_IMAGE",

templates/gitlab-ci-python-vault.yml

@@ -5,7 +5,7 @@ spec:
   inputs:
     vault-base-url:
       description: The Vault server base API url
-      default: '' # null
+      default: ''
     vault-oidc-aud:
       description: The `aud` claim for the JWT
       default: $CI_SERVER_URL

templates/gitlab-ci-python.yml

@@ -47,13 +47,13 @@ spec:
       default: '*'
     pip-opts:
       description: pip extra [options](https://pip.pypa.io/en/stable/cli/pip/#general-options)
-      default: '' # null
+      default: ''
     extra-deps:
       description: |-
         Extra sets of dependencies to install
 
         For [Setuptools](https://setuptools.pypa.io/en/latest/userguide/dependency_management.html?highlight=extras#optional-dependencies) or [Poetry](https://python-poetry.org/docs/pyproject/#extras) only
-      default: '' # null
+      default: ''
     package-enabled:
       description: Enable package
       type: boolean
@@ -64,31 +64,31 @@ spec:
       default: false
     pylint-args:
       description: Additional [pylint CLI options](http://pylint.pycqa.org/en/latest/user_guide/run.html#command-line-options)
-      default: '' # null
+      default: ''
     pylint-files:
       description: Files or directories to analyse
-      default: '' # null
+      default: ''
     unittest-enabled:
       description: Enable unittest
       type: boolean
       default: false
     unittest-args:
       description: Additional xmlrunner/unittest CLI options
-      default: '' # null
+      default: ''
     pytest-enabled:
       description: Enable pytest
       type: boolean
       default: false
     pytest-args:
       description: Additional [pytest](https://docs.pytest.org/en/stable/usage.html) or [pytest-cov](https://github.com/pytest-dev/pytest-cov#usage) CLI options
-      default: '' # null
+      default: ''
     nosetests-enabled:
       description: Enable nosetest
       type: boolean
       default: false
     nosetests-args:
       description: Additional [nose CLI options](https://nose.readthedocs.io/en/latest/usage.html#options)
-      default: '' # null
+      default: ''
     bandit-enabled:
       description: Enable Bandit
       type: boolean
@@ -115,7 +115,7 @@ spec:
         Url to the `tar.gz` package for `linux_amd64` of Syft to use
 
         _When unset, the latest version will be used_
-      default: '' # null
+      default: ''
     sbom-name:
       description: Component name of the emitted SBOM
       default: $CI_PROJECT_PATH/$PYTHON_PROJECT_DIR