diff --git a/.github/workflows/README.md b/.github/workflows/README.md index dbcbb767c..022986ac5 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -37,16 +37,16 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :------------------------------------------------: | :----: | -------------------------------------------------------------------------------------------------------------------- | -| docker-context | ❌ | "." | string | The docker context | -| dockerfile-path | ❌ | "Dockerfile" | string | Path to the Dockerfile | -| docker-registry | ❌ | "" | string | Host where the image should be pushed to | -| image-namespace | ❌ | "" | string | Namespace of Docker image | -| image-name | ❌ | github.event.repository.name | string | Name of Docker image | -| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | string | Tag of Docker image | -| ref | ❌ | "" | string | The ref name to checkout | -| retention-days | ❌ | 1 | string | Number of days the image artifact should be stored on GitHub | -| image-artifact-name | ❌ | "image-artifact" | string | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | -| working-directory | ❌ | "." | string | Working directory for your Docker artifacts | +| docker-context | ❌ | "." | string | The docker context | +| dockerfile-path | ❌ | "Dockerfile" | string | Path to the Dockerfile | +| docker-registry | ❌ | "" | string | Host where the image should be pushed to | +| image-namespace | ❌ | "" | string | Namespace of Docker image | +| image-name | ❌ | github.event.repository.name | string | Name of Docker image | +| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | string | Tag of Docker image | +| ref | ❌ | "" | string | The ref name to checkout | +| retention-days | ❌ | 1 | string | Number of days the image artifact should be stored on GitHub | +| image-artifact-name | ❌ | "image-artifact" | string | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | +| working-directory | ❌ | "." | string | Working directory for your Docker artifacts | ### Secret Parameters @@ -54,9 +54,9 @@ These secrets define the user that pushes the built images to the container regi | Name | Required | Description | | --------------- | :------: | ------------------------------------------- | -| docker-user | ✅ | Username for the Docker registry login | -| docker-password | ✅ | Password for the Docker registry login | -| github-token | ❌ | The GitHub token for committing the changes | +| docker-user | ✅ | Username for the Docker registry login | +| docker-password | ✅ | Password for the Docker registry login | +| github-token | ❌ | The GitHub token for committing the changes | ### Calling the workflow @@ -133,14 +133,14 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ---------------- | :------: | :-----------------------------------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------ | -| page-url | ✅ | | string | URL to the GitHub pages website of the repository. | -| release-type | ✅ | - | string | The scope of the release (major, minor or patch) | -| ref | ❌ | The default branch of your repository | string | The ref name to checkout the repository | -| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see ) | -| helm-version | ❌ | "v3.10.1" | string | The Helm version | -| charts-dir | ❌ | "." | string | The directory containing the Helm chart and `.bumpversion.cfg` file | -| skip-download | ❌ | false | boolean | Skip downloading index.yaml and previous Chart versions from GitHub pages. (To be used during setup of this workflow) | -| artifact-dir | ❌ | "artifact" | string | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | +| page-url | ✅ | | string | URL to the GitHub pages website of the repository. | +| release-type | ✅ | - | string | The scope of the release (major, minor or patch) | +| ref | ❌ | The default branch of your repository | string | The ref name to checkout the repository | +| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see ) | +| helm-version | ❌ | "v3.10.1" | string | The Helm version | +| charts-dir | ❌ | "." | string | The directory containing the Helm chart and `.bumpversion.cfg` file | +| skip-download | ❌ | false | boolean | Skip downloading index.yaml and previous Chart versions from GitHub pages. (To be used during setup of this workflow) | +| artifact-dir | ❌ | "artifact" | string | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | ### Secret Parameters @@ -149,9 +149,9 @@ token (`GH_TOKEN`) of the user. You can use the no reply GitHub email for the em | Name | Required | Description | | --------------- | :------: | ---------------------------------------------- | -| github-username | ✅ | The GitHub username for committing the changes | -| github-email | ✅ | The GitHub email for committing the changes | -| github-token | ✅ | The GitHub token for committing the changes | +| github-username | ✅ | The GitHub username for committing the changes | +| github-email | ✅ | The GitHub email for committing the changes | +| github-token | ✅ | The GitHub token for committing the changes | ### Outputs @@ -228,12 +228,12 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ---------------- | :------: | :------------------------: | :----: | ------------------------------------------------------------------------------------------------------------------------------------------ | -| charts-path | ✅ | | string | The path to the directory containing the Helm chart(s) | -| subdirs | ✅ | | string | List of subdir to consider" Format: "['subdir1', 'subdir2', 'subdir3']" | -| artifact-dir | ❌ | "artifacts" | string | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | -| gh-pages-branch | ❌ | "gh-pages" | string | The branch containing all the artifacts | -| helm-version | ❌ | "v3.10.1" | string | The Helm version | -| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see ) | +| charts-path | ✅ | | string | The path to the directory containing the Helm chart(s) | +| subdirs | ✅ | | string | List of subdir to consider" Format: "\['subdir1', 'subdir2', 'subdir3'\]" | +| artifact-dir | ❌ | "artifacts" | string | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | +| gh-pages-branch | ❌ | "gh-pages" | string | The branch containing all the artifacts | +| helm-version | ❌ | "v3.10.1" | string | The Helm version | +| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see ) | ### Secret Parameters @@ -242,9 +242,9 @@ token (`GH_TOKEN`) of the user. You can use the no reply GitHub email for the em | Name | Required | Description | | --------------- | :------: | ---------------------------------------------- | -| github-username | ✅ | The GitHub username for committing the changes | -| github-email | ✅ | The GitHub email for committing the changes | -| github-token | ✅ | The GitHub token for committing the changes | +| github-username | ✅ | The GitHub username for committing the changes | +| github-email | ✅ | The GitHub email for committing the changes | +| github-token | ✅ | The GitHub token for committing the changes | ### Calling the workflow @@ -290,7 +290,7 @@ jobs: github-token: "${{ secrets.GH_TOKEN }}" ``` ---- +______________________________________________________________________ ## Release Tag Versions @@ -328,10 +328,10 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ----------------------- | :------: | :-----------: | :----: | -------------------------------------------------------------------------------------------------------------- | -| version-configs-dir | ✅ | - | string | The Path to the directory containing the file where the versioning is defined and the `.bumpversion.cfg` file. | -| release-type | ✅ | - | string | Scope of the release (major, minor or patch). | -| next-dev-release-type | ✅ | - | string | Scope of the next release (minor or patch) for developers. | -| next-dev-release-suffix | ❌ | "SNAPSHOT" | string | The suffix to add for the developer version. | +| version-configs-dir | ✅ | - | string | The Path to the directory containing the file where the versioning is defined and the `.bumpversion.cfg` file. | +| release-type | ✅ | - | string | Scope of the release (major, minor or patch). | +| next-dev-release-type | ✅ | - | string | Scope of the next release (minor or patch) for developers. | +| next-dev-release-suffix | ❌ | "SNAPSHOT" | string | The suffix to add for the developer version. | ### Secret Parameters @@ -340,9 +340,9 @@ You can use the no-reply GitHub email for the email: `[username]@users.noreply.g | Name | Required | Description | | --------------- | :------: | ---------------------------------------------- | -| github-username | ✅ | The GitHub username for committing the changes | -| github-email | ✅ | The GitHub email for committing the changes | -| github-token | ✅ | The GitHub token for committing the changes | +| github-username | ✅ | The GitHub username for committing the changes | +| github-email | ✅ | The GitHub email for committing the changes | +| github-token | ✅ | The GitHub token for committing the changes | ### Calling the workflow @@ -389,11 +389,11 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :----: | -------------------------------------------------- | -| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | -| timeout | ❌ | 60 | string | Time out(in seconds) for CustomResourceDefinitions | -| gcloud-sdk-version | ❌ | "376.0.0" | string | GCloud-SDK version | -| kubectl-version | ❌ | "v1.23.0" | string | Kubectl version | -| helm-version | ❌ | "v3.8.1" | string | Helm version | +| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | +| timeout | ❌ | 60 | string | Time out(in seconds) for CustomResourceDefinitions | +| gcloud-sdk-version | ❌ | "376.0.0" | string | GCloud-SDK version | +| kubectl-version | ❌ | "v1.23.0" | string | Kubectl version | +| helm-version | ❌ | "v3.8.1" | string | Helm version | ### Secret Parameters @@ -401,10 +401,10 @@ The GKE cluster that will be used for the deployment is defined by these secrets | Name | Required | Description | | ------------------- | :------: | ------------------------------------------ | -| gke-service-account | ✅ | GKE service account key for authentication | -| gke-project | ✅ | GKE project id for authentication | -| gke-region | ✅ | GKE region for authentication | -| gke-cluster | ✅ | GKE cluster for authentication | +| gke-service-account | ✅ | GKE service account key for authentication | +| gke-project | ✅ | GKE project id for authentication | +| gke-region | ✅ | GKE region for authentication | +| gke-cluster | ✅ | GKE cluster for authentication | ### Calling the workflow @@ -454,10 +454,10 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :----: | ----------------------------------------------- | -| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | -| gcloud-sdk-version | ❌ | "376.0.0" | string | GCloud-SDK version | -| kubectl-version | ❌ | "v1.23.0" | string | Kubectl version | -| helm-version | ❌ | "v3.8.1" | string | Helm version | +| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | +| gcloud-sdk-version | ❌ | "376.0.0" | string | GCloud-SDK version | +| kubectl-version | ❌ | "v1.23.0" | string | Kubectl version | +| helm-version | ❌ | "v3.8.1" | string | Helm version | ### Secret Parameters @@ -465,10 +465,10 @@ The GKE cluster that will be used for the deployment is defined by these secrets | Name | Required | Description | | ------------------- | :------: | ------------------------------------------ | -| gke-service-account | ✅ | GKE service account key for authentication | -| gke-project | ✅ | GKE project id for authentication | -| gke-region | ✅ | GKE region for authentication | -| gke-cluster | ✅ | GKE cluster for authentication | +| gke-service-account | ✅ | GKE service account key for authentication | +| gke-project | ✅ | GKE project id for authentication | +| gke-region | ✅ | GKE region for authentication | +| gke-cluster | ✅ | GKE cluster for authentication | ### Calling the workflow @@ -529,13 +529,13 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------------------------------: | :-----: | --------------------------------------------------------------------------------------------------------------------------------- | -| release-type | ✅ | - | string | Scope of the release, see the official [documentation of Poetry](https://python-poetry.org/docs/cli/#version) for possible values | -| ref | ❌ | The default branch of your repository | string | ref name to checkout the repository | -| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | -| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | -| changelog | ❌ | true | boolean | If set to true, a CHANGELOG.md will be created when a release is done | -| changelog-config | ❌ | - | string | Path to the changelog config file. Only needed if changelog is set to true | -| working-directory | ❌ | "./" | string | Working directory of your Python package | +| release-type | ✅ | - | string | Scope of the release, see the official [documentation of Poetry](https://python-poetry.org/docs/cli/#version) for possible values | +| ref | ❌ | The default branch of your repository | string | ref name to checkout the repository | +| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | +| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | +| changelog | ❌ | true | boolean | If set to true, a CHANGELOG.md will be created when a release is done | +| changelog-config | ❌ | - | string | Path to the changelog config file. Only needed if changelog is set to true | +| working-directory | ❌ | "./" | string | Working directory of your Python package | ### Secret Parameters @@ -546,9 +546,9 @@ email: `[username]@users.noreply.github.com`. | Name | Required | Description | | --------------- | :------: | ---------------------------------------------- | -| github-username | ✅ | The GitHub username for committing the changes | -| github-email | ✅ | The GitHub email for committing the changes | -| github-token | ✅ | The GitHub token for committing the changes | +| github-username | ✅ | The GitHub username for committing the changes | +| github-email | ✅ | The GitHub email for committing the changes | +| github-token | ✅ | The GitHub token for committing the changes | ### Outputs @@ -614,10 +614,10 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| publish-to-test | ❌ | true | boolean | If set to true, the packages are published to test.pypi.org other wise the packages are published to pypi.org | -| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | -| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | -| working-directory | ❌ | "./" | string | Working directory of your Python package | +| publish-to-test | ❌ | true | boolean | If set to true, the packages are published to test.pypi.org other wise the packages are published to pypi.org | +| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | +| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | +| working-directory | ❌ | "./" | string | Working directory of your Python package | ### Secret Parameters @@ -625,7 +625,7 @@ These secrets define the PyPI token that allow the GitHub action to release the | Name | Required | Description | | ---------- | :------: | ------------------------------------------------ | -| pypi-token | ✅ | The (Test)PyPI API token for publishing packages | +| pypi-token | ✅ | The (Test)PyPI API token for publishing packages | ### Calling the workflow @@ -668,9 +668,9 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :----: | ---------------------------------------- | -| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | -| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | -| working-directory | ❌ | "./" | string | Working directory of your Python package | +| python-version | ❌ | "3.10" | string | Python version for setting up Poetry | +| poetry-version | ❌ | "1.5.1" | string | Poetry version to be installed | +| working-directory | ❌ | "./" | string | Working directory of your Python package | ### Secret Parameters @@ -678,7 +678,7 @@ These secrets define the TestPyPI token that allow the GitHub action to release | Name | Required | Description | | ---------- | :------: | ---------------------------------------------- | -| pypi-token | ✅ | The TestPyPI API token for publishing packages | +| pypi-token | ✅ | The TestPyPI API token for publishing packages | ### Calling the workflow @@ -720,12 +720,12 @@ This workflow is built from multiple composite actions listed below: | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | -| download-lfs-files | ❌ | "false" | string | Whether the Git checkout action should resolve LFS files or not | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | +| download-lfs-files | ❌ | "false" | string | Whether the Git checkout action should resolve LFS files or not | ### Secret Parameters @@ -735,11 +735,11 @@ your build artifacts. | Name | Required | Description | | ----------------------- | :------: | -------------------------------------------------------------- | -| signing-key-id | ✅ | Key id for signing the Sonatype publication | -| signing-password | ✅ | Password for signing the Sonatype publication | -| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | -| sonar-organization | ✅ | Organization for Sonarcloud | -| sonar-token | ✅ | Token for Sonarcloud | +| signing-key-id | ✅ | Key id for signing the Sonatype publication | +| signing-password | ✅ | Password for signing the Sonatype publication | +| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | +| sonar-organization | ✅ | Organization for Sonarcloud | +| sonar-token | ✅ | Token for Sonarcloud | ### Calling the workflow @@ -792,12 +792,12 @@ This workflow is built from multiple composite actions and workflows listed belo | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| docker-publisher | ✅ | - | string | Publisher to prefix Docker image | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | +| docker-publisher | ✅ | - | string | Publisher to prefix Docker image | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | ### Secret Parameters @@ -810,17 +810,17 @@ a tag branch. | Name | Required | Description | | ----------------------- | :------: | -------------------------------------------------------------- | -| sonar-token | ✅ | Token for Sonarcloud | -| sonar-organization | ✅ | Organization for Sonarcloud | -| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | -| signing-key-id | ✅ | Key id for signing the Sonatype publication | -| signing-password | ✅ | Password for signing the Sonatype publication | -| ossrh-username | ✅ | Username for signing into Sonatype repository | -| ossrh-password | ✅ | Password for signing into Sonatype repository | -| docker-username | ✅ | Username for publishing to Dockerhub | -| docker-password | ✅ | Password for publishing to Dockerhub | -| github-username | ✅ | GitHub username for requesting changes from API | -| github-token | ✅ | GitHub token for requesting changes from API | +| sonar-token | ✅ | Token for Sonarcloud | +| sonar-organization | ✅ | Organization for Sonarcloud | +| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | +| signing-key-id | ✅ | Key id for signing the Sonatype publication | +| signing-password | ✅ | Password for signing the Sonatype publication | +| ossrh-username | ✅ | Username for signing into Sonatype repository | +| ossrh-password | ✅ | Password for signing into Sonatype repository | +| docker-username | ✅ | Username for publishing to Dockerhub | +| docker-password | ✅ | Password for publishing to Dockerhub | +| github-username | ✅ | GitHub username for requesting changes from API | +| github-token | ✅ | GitHub token for requesting changes from API | ### Calling the workflow @@ -878,11 +878,11 @@ This workflow is built from multiple composite actions and workflows listed belo | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | ### Secret Parameters @@ -894,15 +894,15 @@ changelog when running on a tag branch. | Name | Required | Description | | ----------------------- | :------: | -------------------------------------------------------------- | -| sonar-token | ✅ | Token for Sonarcloud | -| sonar-organization | ✅ | Organization for Sonarcloud | -| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | -| signing-key-id | ✅ | Key id for signing the Sonatype publication | -| signing-password | ✅ | Password for signing the Sonatype publication | -| ossrh-username | ✅ | Username for signing into Sonatype repository | -| ossrh-password | ✅ | Password for signing into Sonatype repository | -| github-username | ✅ | GitHub username for requesting changes from API | -| github-token | ✅ | GitHub token for requesting changes from API | +| sonar-token | ✅ | Token for Sonarcloud | +| sonar-organization | ✅ | Organization for Sonarcloud | +| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | +| signing-key-id | ✅ | Key id for signing the Sonatype publication | +| signing-password | ✅ | Password for signing the Sonatype publication | +| ossrh-username | ✅ | Username for signing into Sonatype repository | +| ossrh-password | ✅ | Password for signing into Sonatype repository | +| github-username | ✅ | GitHub username for requesting changes from API | +| github-token | ✅ | GitHub token for requesting changes from API | ### Calling the workflow @@ -959,11 +959,11 @@ This workflow is built from multiple composite actions and workflows listed belo | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | ### Secret Parameters @@ -976,17 +976,17 @@ changelog when running on a tag branch. | Name | Required | Description | | ----------------------- | :------: | -------------------------------------------------------------- | -| sonar-token | ✅ | Token for Sonarcloud | -| sonar-organization | ✅ | Organization for Sonarcloud | -| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | -| signing-key-id | ✅ | Key id for signing the Sonatype publication | -| signing-password | ✅ | Password for signing the Sonatype publication | -| ossrh-username | ✅ | Username for signing into Sonatype repository | -| ossrh-password | ✅ | Password for signing into Sonatype repository | -| gradle-publish-key | ✅ | Key for publishing to Gradle Plugin Portal | -| gradle-publish-secret | ✅ | Secret for publishing to Gradle Plugin Portal | -| github-username | ✅ | GitHub username for requesting changes from API | -| github-token | ✅ | GitHub token for requesting changes from API | +| sonar-token | ✅ | Token for Sonarcloud | +| sonar-organization | ✅ | Organization for Sonarcloud | +| signing-secret-key-ring | ✅ | Key ring (base64 encoded) for signing the Sonatype publication | +| signing-key-id | ✅ | Key id for signing the Sonatype publication | +| signing-password | ✅ | Password for signing the Sonatype publication | +| ossrh-username | ✅ | Username for signing into Sonatype repository | +| ossrh-password | ✅ | Password for signing into Sonatype repository | +| gradle-publish-key | ✅ | Key for publishing to Gradle Plugin Portal | +| gradle-publish-secret | ✅ | Secret for publishing to Gradle Plugin Portal | +| github-username | ✅ | GitHub username for requesting changes from API | +| github-token | ✅ | GitHub token for requesting changes from API | ### Calling the workflow @@ -1042,13 +1042,13 @@ This workflow is built from another composite action listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :------------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| release-type | ✅ | - | string | Scope of the release (major, minor or patch) | -| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | +| release-type | ✅ | - | string | Scope of the release (major, minor or patch) | +| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| working-directory | ❌ | . | string | Working directory of your Gradle artifacts | ### Secret Parameters @@ -1057,9 +1057,9 @@ a `github-token`. | Name | Required | Description | | --------------- | :------: | ------------------------------------------ | -| github-username | ✅ | GitHub username for committing the changes | -| github-email | ✅ | GitHub email for committing the changes | -| github-token | ✅ | GitHub token for committing the changes | +| github-username | ✅ | GitHub username for committing the changes | +| github-email | ✅ | GitHub email for committing the changes | +| github-token | ✅ | GitHub token for committing the changes | ### Outputs @@ -1128,10 +1128,10 @@ This workflow is built from other composite actions listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | -------------------------------------------------------------------------- | -| release-type | ✅ | - | string | Scope of the release (major, minor or patch) | -| changelog | ❌ | true | boolean | Create changelog for release | -| changelog-config | ❌ | - | string | Path to the changelog config file. Only needed if changelog is set to true | -| working-directory | ❌ | . | string | Working directory of project containing `.bumpversion.cfg` | +| release-type | ✅ | - | string | Scope of the release (major, minor or patch) | +| changelog | ❌ | true | boolean | Create changelog for release | +| changelog-config | ❌ | - | string | Path to the changelog config file. Only needed if changelog is set to true | +| working-directory | ❌ | . | string | Working directory of project containing `.bumpversion.cfg` | ### Secret Parameters @@ -1140,9 +1140,9 @@ a `github-token`. | Name | Required | Description | | --------------- | :------: | ------------------------------------------ | -| github-username | ✅ | GitHub username for committing the changes | -| github-email | ✅ | GitHub email for committing the changes | -| github-token | ✅ | GitHub token for committing the changes | +| github-username | ✅ | GitHub username for committing the changes | +| github-email | ✅ | GitHub email for committing the changes | +| github-token | ✅ | GitHub token for committing the changes | ### Outputs diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 49225e88a..a563aa6f3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,6 +6,15 @@ repos: language: script name: Generate doc entry: ./generate-doc.sh - stage: [manual] - # stage: [commit] + # stages: + # - "manual" + - repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 + hooks: + - id: mdformat + additional_dependencies: + - mdformat-gfm + - mdformat-black + # stages: + # - "manual" diff --git a/actions/action-lint/README.md b/actions/action-lint/README.md index 881966ba2..4ff3633fa 100644 --- a/actions/action-lint/README.md +++ b/actions/action-lint/README.md @@ -6,8 +6,8 @@ This action will lint all actions and workflows of a repository. | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :-----------: | :----: | ------------------------------------------ | -| ref | ❌ | "" | string | The ref name to checkout the repository. | -| action-lint-version | ❌ | v1.6.22 | string | The action lint repository version to use. | +| ref | ❌ | "" | string | The ref name to checkout the repository. | +| action-lint-version | ❌ | v1.6.22 | string | The action lint repository version to use. | ## Usage diff --git a/actions/bump-version/README.md b/actions/bump-version/README.md index 6844ead3b..f4c2ea2a9 100644 --- a/actions/bump-version/README.md +++ b/actions/bump-version/README.md @@ -18,9 +18,9 @@ current_version = 0.0.1 | Name | Required | Default Value | Description | | ----------------- | :------: | :-----------: | ----------------------------------------------------- | -| release-type | ✅ | - | The scope of the release (major, minor or patch) | -| working-directory | ❌ | . | The directory containing the `.bumpversion.cfg` file. | -| new-version | ❌ | . | New version to use for the bump | +| release-type | ✅ | - | The scope of the release (major, minor or patch) | +| working-directory | ❌ | . | The directory containing the `.bumpversion.cfg` file. | +| new-version | ❌ | . | New version to use for the bump | ### Outputs diff --git a/actions/changelog-generate/README.md b/actions/changelog-generate/README.md index 6f4cbf967..f10d61faf 100644 --- a/actions/changelog-generate/README.md +++ b/actions/changelog-generate/README.md @@ -55,14 +55,14 @@ Additional configuration options can be explored | Name | Required | Default Value | Description | | ------------------------- | :------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| github-token | ✅ | - | The GitHub token for committing the changes | -| new-tag | ✅ | - | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) | -| changelog-file | ❌ | "CHANGELOG.md" | Path to the Changelog.md file | -| commit-mode | ❌ | "false" | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. | -| config | ❌ | "" | Path to the changelog config JSON file | -| fetch-release-information | ❌ | "false" | Will enable fetching additional release information from tags. | -| fetch-reviewers | ❌ | "false" | Will enable fetching the users/reviewers who approved the PR. | -| old-tag | ❌ | "" | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) | +| github-token | ✅ | - | The GitHub token for committing the changes | +| new-tag | ✅ | - | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) | +| changelog-file | ❌ | "CHANGELOG.md" | Path to the Changelog.md file | +| commit-mode | ❌ | "false" | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. | +| config | ❌ | "" | Path to the changelog config JSON file | +| fetch-release-information | ❌ | "false" | Will enable fetching additional release information from tags. | +| fetch-reviewers | ❌ | "false" | Will enable fetching the users/reviewers who approved the PR. | +| old-tag | ❌ | "" | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) | ## Outputs diff --git a/actions/checkout/README.md b/actions/checkout/README.md index 0faacabd8..12e42f898 100644 --- a/actions/checkout/README.md +++ b/actions/checkout/README.md @@ -17,13 +17,13 @@ This workflow is built from other composite actions listed below: | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :------------------------: | :----: | ------------------------------------------------------------------------------------------------------------ | -| cache | ❌ | "true" | string | Whether to cache the LFS files in this repository. This variable has an impact only if lfs is set to `true`. | -| fetch-depth | ❌ | "1" | string | Number of commits to fetch. 0 indicates all history for all branches and tags. | -| lfs | ❌ | "false" | string | Define whether to use LFS files. | -| persist-credentials | ❌ | "true" | string | Whether to configure the token or SSH key with the local git config. | -| ref | ❌ | "" | string | The branch, tag or SHA to checkout. | -| repository | ❌ | "${{ github.repository }}" | string | The repository name with owner. | -| token | ❌ | "${{ github.token }}" | string | Personal access token (PAT) used to fetch the repository. | +| cache | ❌ | "true" | string | Whether to cache the LFS files in this repository. This variable has an impact only if lfs is set to `true`. | +| fetch-depth | ❌ | "1" | string | Number of commits to fetch. 0 indicates all history for all branches and tags. | +| lfs | ❌ | "false" | string | Define whether to use LFS files. | +| persist-credentials | ❌ | "true" | string | Whether to configure the token or SSH key with the local git config. | +| ref | ❌ | "" | string | The branch, tag or SHA to checkout. | +| repository | ❌ | "${{ github.repository }}" | string | The repository name with owner. | +| token | ❌ | "${{ github.token }}" | string | Personal access token (PAT) used to fetch the repository. | ### Outputs diff --git a/actions/commit-and-push/README.md b/actions/commit-and-push/README.md index 0e6f30987..dc370b365 100644 --- a/actions/commit-and-push/README.md +++ b/actions/commit-and-push/README.md @@ -9,13 +9,13 @@ This composite action commits the changes of your repository with an arbitrary c | Name | Required | Default Value | Description | | ----------------- | :------: | :-------------------------------: | -------------------------------------------------- | -| github-username | ✅ | - | The GitHub username for committing the changes | -| github-email | ✅ | - | The GitHub email for committing the changes | -| github-token | ✅ | - | The GitHub token for committing the changes | -| commit-message | ✅ | - | The commit message | -| ref | ❌ | Default branch of your repository | The ref name to commit and push the files on | -| add-untracked | ❌ | "false" | Whether to add untracked files to commit | -| pass-empty-commit | ❌ | "false" | Whether to exit with code 0 when nothing to commit | +| github-username | ✅ | - | The GitHub username for committing the changes | +| github-email | ✅ | - | The GitHub email for committing the changes | +| github-token | ✅ | - | The GitHub token for committing the changes | +| commit-message | ✅ | - | The commit message | +| ref | ❌ | Default branch of your repository | The ref name to commit and push the files on | +| add-untracked | ❌ | "false" | Whether to add untracked files to commit | +| pass-empty-commit | ❌ | "false" | Whether to exit with code 0 when nothing to commit | ## Usage diff --git a/actions/docker-build/README.md b/actions/docker-build/README.md index f861d08ed..c0e81e4dd 100644 --- a/actions/docker-build/README.md +++ b/actions/docker-build/README.md @@ -10,12 +10,12 @@ Ensure that your Dockerfile is uploaded to the repository you want to use this a | Name | Required | Default Value | Description | | ------------------- | :------: | :--------------------------: | -------------------------------------------------------------------------------------------------------------------- | -| docker-context | ❌ | "." | The docker context. | -| dockerfile-path | ❌ | "Dockerfile" | Path to the Dockerfile. | -| image-name | ❌ | github.event.repository.name | Name of Docker image on Dockerhub | -| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | -| retention-days | ❌ | 1 | Number of days the image artifact should be stored on GitHub | -| working-directory | ❌ | "." | Working directory for your Docker artifacts | +| docker-context | ❌ | "." | The docker context. | +| dockerfile-path | ❌ | "Dockerfile" | Path to the Dockerfile. | +| image-name | ❌ | github.event.repository.name | Name of Docker image on Dockerhub | +| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | +| retention-days | ❌ | 1 | Number of days the image artifact should be stored on GitHub | +| working-directory | ❌ | "." | Working directory for your Docker artifacts | ## Usage diff --git a/actions/docker-publish/README.md b/actions/docker-publish/README.md index 78d56b95b..860c0c84c 100644 --- a/actions/docker-publish/README.md +++ b/actions/docker-publish/README.md @@ -10,12 +10,12 @@ Create an action that [uploads a tarball image as an artifact](https://github.co | Name | Required | Default Value | Description | | ------------------- | :------: | :------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------- | -| docker-registry | ❌ | "" | Host where the image should be pushed to | -| image-namespace | ❌ | "" | Namespace of Docker image | -| image-name | ❌ | github.event.repository.name | Name of Docker image | -| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image | -| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | -| working-directory | ❌ | "." | Working directory for your Docker artifacts | +| docker-registry | ❌ | "" | Host where the image should be pushed to | +| image-namespace | ❌ | "" | Namespace of Docker image | +| image-name | ❌ | github.event.repository.name | Name of Docker image | +| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image | +| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact | +| working-directory | ❌ | "." | Working directory for your Docker artifacts | ## Usage diff --git a/actions/docker-push/README.md b/actions/docker-push/README.md index 97b11be7e..9c98995ab 100644 --- a/actions/docker-push/README.md +++ b/actions/docker-push/README.md @@ -10,11 +10,11 @@ Have a Docker image with name `${{ image-name }}` available in the Docker contex | Name | Required | Default Value | Description | | ----------------- | :------: | :------------------------------------------------: | ------------------------------------------- | -| docker-registry | ❌ | "" | Host where the image should be pushed to | -| image-namespace | ❌ | "" | Namespace of Docker image | -| image-name | ❌ | github.event.repository.name | Name of Docker image | -| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image | -| working-directory | ❌ | "." | Working directory for your Docker artifacts | +| docker-registry | ❌ | "" | Host where the image should be pushed to | +| image-namespace | ❌ | "" | Namespace of Docker image | +| image-name | ❌ | github.event.repository.name | Name of Docker image | +| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image | +| working-directory | ❌ | "." | Working directory for your Docker artifacts | ## Usage diff --git a/actions/helm-deploy/README.md b/actions/helm-deploy/README.md index 8a5cd13b9..10066887b 100644 --- a/actions/helm-deploy/README.md +++ b/actions/helm-deploy/README.md @@ -10,17 +10,17 @@ Create a `values.yaml` file according to the documentation of the specific Helm | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :-----------: | :----: | ------------------------------------------------------------------------------------------------- | -| release-name | ✅ | - | string | The release name of the Helm deployment | -| namespace | ✅ | - | string | The namespace of the Helm deployment | -| chart | ✅ | - | string | The name of the Helm chart | -| values-yaml | ✅ | - | string | File path as string for a single values.yaml file or as JSON array for multiple values.yaml files | -| chart-version | ❌ | - | string | The version of the Helm chart | -| post-renderer | ❌ | - | string | File path as string for a Helm post renderer | -| timeout | ❌ | 1200 | string | Timeout for the Helm command in seconds | -| repository-name | ❌ | - | string | The local name for adding the Helm repository | -| repository-url | ❌ | - | string | The url for adding the Helm repository | -| repository-username | ❌ | - | string | User for the login to the repository | -| repository-password | ❌ | - | string | Password for the login to the repository | +| release-name | ✅ | - | string | The release name of the Helm deployment | +| namespace | ✅ | - | string | The namespace of the Helm deployment | +| chart | ✅ | - | string | The name of the Helm chart | +| values-yaml | ✅ | - | string | File path as string for a single values.yaml file or as JSON array for multiple values.yaml files | +| chart-version | ❌ | - | string | The version of the Helm chart | +| post-renderer | ❌ | - | string | File path as string for a Helm post renderer | +| timeout | ❌ | 1200 | string | Timeout for the Helm command in seconds | +| repository-name | ❌ | - | string | The local name for adding the Helm repository | +| repository-url | ❌ | - | string | The url for adding the Helm repository | +| repository-username | ❌ | - | string | User for the login to the repository | +| repository-password | ❌ | - | string | Password for the login to the repository | ## Usage diff --git a/actions/helm-destroy/README.md b/actions/helm-destroy/README.md index f395bcfb7..ca4d10f4b 100644 --- a/actions/helm-destroy/README.md +++ b/actions/helm-destroy/README.md @@ -6,8 +6,8 @@ This action will destroy a Helm chart on a Kubernetes cluster. | Name | Required | Default Value | Type | Description | | ------------ | :------: | :-----------: | :----: | --------------------------------------- | -| release-name | ✅ | - | string | The release name of the Helm deployment | -| namespace | ✅ | - | string | The namespace of the Helm deployment | +| release-name | ✅ | - | string | The release name of the Helm deployment | +| namespace | ✅ | - | string | The namespace of the Helm deployment | ## Usage diff --git a/actions/helm-lint/README.md b/actions/helm-lint/README.md index 1aebec9a3..fd92f3333 100644 --- a/actions/helm-lint/README.md +++ b/actions/helm-lint/README.md @@ -16,9 +16,9 @@ target-branch: "main" | Name | Required | Default Value | Type | Description | | ---------------- | :------: | :------------------------: | :----: | ---------------------------------------------------------------------------------------------------------------------------------------- | -| ref | ❌ | The current branch | string | The ref name to checkout the repository | -| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml) | -| helm-version | ❌ | "v3.10.1" | string | The Helm version | +| ref | ❌ | The current branch | string | The ref name to checkout the repository | +| lint-config-path | ❌ | ".github/lint-config.yaml" | string | The path to the lint configuration file (For an example see https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml) | +| helm-version | ❌ | "v3.10.1" | string | The Helm version | ## Usage diff --git a/actions/helm-package/README.md b/actions/helm-package/README.md index 516efccf5..ef0d238a0 100644 --- a/actions/helm-package/README.md +++ b/actions/helm-package/README.md @@ -6,8 +6,8 @@ This composite action packages a Helm chart. Afterwards, it creates an index fil | Name | Required | Default Value | Description | | ------------ | :------: | :-----------: | --------------------------------------- | -| helm-version | ❌ | "v3.10.1" | The Helm version | -| charts-dir | ❌ | "." | The directory containing the Helm chart | +| helm-version | ❌ | "v3.10.1" | The Helm version | +| charts-dir | ❌ | "." | The directory containing the Helm chart | ## Usage diff --git a/actions/helm-setup/README.md b/actions/helm-setup/README.md index 1aae7727a..4183a570a 100644 --- a/actions/helm-setup/README.md +++ b/actions/helm-setup/README.md @@ -6,8 +6,8 @@ This action will set up everything necessary to deploy or destroy Helm charts. | Name | Required | Default Value | Type | Description | | --------------- | :------: | :-----------: | :----: | ------------------------------ | -| kubectl-version | ❌ | v1.23.0 | string | The kubectl version to install | -| helm-version | ❌ | v3.10.1 | string | The Helm version to install | +| kubectl-version | ❌ | v1.23.0 | string | The kubectl version to install | +| helm-version | ❌ | v3.10.1 | string | The Helm version to install | ## Usage diff --git a/actions/java-gradle-assess-code-quality/README.md b/actions/java-gradle-assess-code-quality/README.md index b45a3f964..267c494ab 100644 --- a/actions/java-gradle-assess-code-quality/README.md +++ b/actions/java-gradle-assess-code-quality/README.md @@ -9,17 +9,17 @@ Sonatype, then these steps are skipped. | Name | Required | Default Value | Type | Description | | ----------------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| sonar-organization | ❌ | - | string | Organization for Sonarcloud | -| sonar-token | ❌ | - | string | Token for Sonarcloud | -| signing-key-id | ❌ | - | string | Key id for signing the Sonatype publication | -| signing-password | ❌ | - | string | Password for signing the Sonatype publication | -| signing-secret-key-ring | ❌ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| sonar-organization | ❌ | - | string | Organization for Sonarcloud | +| sonar-token | ❌ | - | string | Token for Sonarcloud | +| signing-key-id | ❌ | - | string | Key id for signing the Sonatype publication | +| signing-password | ❌ | - | string | Password for signing the Sonatype publication | +| signing-secret-key-ring | ❌ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-build-jib/README.md b/actions/java-gradle-build-jib/README.md index 7fe6a4ba2..b7f072a5a 100644 --- a/actions/java-gradle-build-jib/README.md +++ b/actions/java-gradle-build-jib/README.md @@ -6,15 +6,15 @@ This action builds an image tarball using [Jib Gradle](https://github.com/Google | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------- | -| image-artifact-name | ❌ | image-artifact | string | Artifact name to upload tarball image, see | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | -| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | -| subproject | ❌ | | string | The Gradle subproject for which the tarball image should be built (If not specified, a tarball image for the root project will be built) | -| jib-from-image | ❌ | | string | The Jib base image to use | +| image-artifact-name | ❌ | image-artifact | string | Artifact name to upload tarball image, see | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | +| subproject | ❌ | | string | The Gradle subproject for which the tarball image should be built (If not specified, a tarball image for the root project will be built) | +| jib-from-image | ❌ | | string | The Jib base image to use | ## Usage diff --git a/actions/java-gradle-build/README.md b/actions/java-gradle-build/README.md index 0e94291f1..d6472c884 100644 --- a/actions/java-gradle-build/README.md +++ b/actions/java-gradle-build/README.md @@ -6,12 +6,12 @@ This action builds Java artifacts using Gradle and uploads `.jar` files as an ar | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :------------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| build-artifact-name | ❌ | build-artifact | string | [Artifact](https://github.com/actions/upload-artifact) name that is used for uploading build artifacts | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| build-artifact-name | ❌ | build-artifact | string | [Artifact](https://github.com/actions/upload-artifact) name that is used for uploading build artifacts | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-publish-plugin/README.md b/actions/java-gradle-publish-plugin/README.md index 87f392381..17eac6892 100644 --- a/actions/java-gradle-publish-plugin/README.md +++ b/actions/java-gradle-publish-plugin/README.md @@ -6,16 +6,16 @@ This action uses Gradle to publish Java plugins to the Gradle Plugin Portal. | Name | Required | Default Value | Type | Description | | ----------------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| signing-secret-key-ring | ✅ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | -| signing-key-id | ✅ | - | string | Key id for signing the Sonatype publication | -| signing-password | ✅ | - | string | Password for signing the Sonatype publication | -| gradle-publish-key | ✅ | - | string | Key for publishing to Gradle Plugin Portal | -| gradle-publish-secret | ✅ | - | string | Secret for publishing to Gradle Plugin Portal | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| signing-secret-key-ring | ✅ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | +| signing-key-id | ✅ | - | string | Key id for signing the Sonatype publication | +| signing-password | ✅ | - | string | Password for signing the Sonatype publication | +| gradle-publish-key | ✅ | - | string | Key for publishing to Gradle Plugin Portal | +| gradle-publish-secret | ✅ | - | string | Secret for publishing to Gradle Plugin Portal | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-publish/README.md b/actions/java-gradle-publish/README.md index ee4a91229..e2d657b55 100644 --- a/actions/java-gradle-publish/README.md +++ b/actions/java-gradle-publish/README.md @@ -6,16 +6,16 @@ This action uses Gradle to publish Java artifacts to Sonatype Nexus. | Name | Required | Default Value | Type | Description | | ----------------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| signing-secret-key-ring | ✅ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | -| signing-key-id | ✅ | - | string | Key id for signing the Sonatype publication | -| signing-password | ✅ | - | string | Password for signing the Sonatype publication | -| ossrh-username | ✅ | - | string | Username for signing into Sonatype repository | -| ossrh-password | ✅ | - | string | Password for signing into Sonatype repository | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| signing-secret-key-ring | ✅ | - | string | Key ring (base64 encoded) for signing the Sonatype publication | +| signing-key-id | ✅ | - | string | Key id for signing the Sonatype publication | +| signing-password | ✅ | - | string | Password for signing the Sonatype publication | +| ossrh-username | ✅ | - | string | Username for signing into Sonatype repository | +| ossrh-password | ✅ | - | string | Password for signing into Sonatype repository | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-release-github/README.md b/actions/java-gradle-release-github/README.md index c35ffd09d..72a879662 100644 --- a/actions/java-gradle-release-github/README.md +++ b/actions/java-gradle-release-github/README.md @@ -6,14 +6,14 @@ This action releases Java Gradle Artifacts and a generated changelog on Github. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :------------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | -| github-username | ✅ | - | string | GitHub username for requesting changes from API | -| github-token | ✅ | - | string | GitHub token for requesting changes from API | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | +| github-username | ✅ | - | string | GitHub username for requesting changes from API | +| github-token | ✅ | - | string | GitHub token for requesting changes from API | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-release/README.md b/actions/java-gradle-release/README.md index ae6de9cbe..3cdee0134 100644 --- a/actions/java-gradle-release/README.md +++ b/actions/java-gradle-release/README.md @@ -6,16 +6,16 @@ This action releases Java Gradle artifacts by createing a tag on GitHub. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :------------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | -| release-type | ✅ | - | string | Scope of the release | -| github-email | ✅ | - | string | GitHub email for requesting changes from API | -| github-username | ✅ | - | string | GitHub username for requesting changes from API | -| github-token | ✅ | - | string | GitHub token for requesting changes from API | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| changelog-file | ❌ | "CHANGELOG.md" | string | Path to the Changelog.md file | +| release-type | ✅ | - | string | Scope of the release | +| github-email | ✅ | - | string | GitHub email for requesting changes from API | +| github-username | ✅ | - | string | GitHub username for requesting changes from API | +| github-token | ✅ | - | string | GitHub token for requesting changes from API | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-gradle-setup/README.md b/actions/java-gradle-setup/README.md index f496221d7..f110bfba6 100644 --- a/actions/java-gradle-setup/README.md +++ b/actions/java-gradle-setup/README.md @@ -6,10 +6,10 @@ This action sets up Java and Gradle. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | ## Usage diff --git a/actions/java-gradle-test/README.md b/actions/java-gradle-test/README.md index 5e0cfe0be..1c1a2bcb8 100644 --- a/actions/java-gradle-test/README.md +++ b/actions/java-gradle-test/README.md @@ -6,12 +6,12 @@ This action runs Junit tests, publishes the test results and tests signing for S | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :-----: | ------------------------------------------------------------------------------------------------------------- | -| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | -| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | -| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | +| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| gradle-cache | ❌ | true | boolean | Whether Gradle caching is enabled or not | +| gradle-version | ❌ | wrapper | string | [Gradle version](https://github.com/gradle/gradle-build-action#use-a-specific-gradle-version) to be installed | +| working-directory | ❌ | "." | string | Working directory of your Gradle artifacts | ## Usage diff --git a/actions/java-maven-build/README.md b/actions/java-maven-build/README.md index 2356e5a07..6dd094939 100644 --- a/actions/java-maven-build/README.md +++ b/actions/java-maven-build/README.md @@ -6,11 +6,11 @@ This action builds Java artifacts using Maven. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :----: | -------------------------------------------------------------------------------------------------- | -| maven-version | ✅ | - | string | Maven version to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | -| command | ❌ | compile | string | Command to run build with | +| maven-version | ✅ | - | string | Maven version to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | +| command | ❌ | compile | string | Command to run build with | ## Usage diff --git a/actions/java-maven-release/README.md b/actions/java-maven-release/README.md index f55709190..c3e4a5154 100644 --- a/actions/java-maven-release/README.md +++ b/actions/java-maven-release/README.md @@ -6,14 +6,14 @@ This action releases Java Maven artifacts by createing a tag on GitHub. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :----: | -------------------------------------------------------------------------------------------------- | -| release-type | ✅ | - | string | Scope of the release | -| github-email | ✅ | - | string | GitHub email for requesting changes from API | -| github-username | ✅ | - | string | GitHub username for requesting changes from API | -| github-token | ✅ | - | string | GitHub token for requesting changes from API | -| maven-version | ✅ | - | string | Maven version to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | +| release-type | ✅ | - | string | Scope of the release | +| github-email | ✅ | - | string | GitHub email for requesting changes from API | +| github-username | ✅ | - | string | GitHub username for requesting changes from API | +| github-token | ✅ | - | string | GitHub token for requesting changes from API | +| maven-version | ✅ | - | string | Maven version to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | ## Usage diff --git a/actions/java-maven-setup/README.md b/actions/java-maven-setup/README.md index 8c122042c..fe75c534b 100644 --- a/actions/java-maven-setup/README.md +++ b/actions/java-maven-setup/README.md @@ -6,9 +6,9 @@ This action sets up Java and Maven. | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :----: | -------------------------------------------------------------------------------------------------- | -| maven-version | ✅ | - | string | Maven version to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | +| maven-version | ✅ | - | string | Maven version to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | ## Usage diff --git a/actions/java-maven-test/README.md b/actions/java-maven-test/README.md index 7eca43e16..4577b5700 100644 --- a/actions/java-maven-test/README.md +++ b/actions/java-maven-test/README.md @@ -6,12 +6,12 @@ This action runs Junit tests and publishes the test results. | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :-----: | -------------------------------------------------------------------------------------------------- | -| maven-version | ✅ | - | string | Maven version to be installed | -| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | -| java-version | ❌ | 11 | string | Java version to be installed | -| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | -| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | -| command | ❌ | test | string | Command to run tests with | +| maven-version | ✅ | - | string | Maven version to be installed | +| java-distribution | ❌ | microsoft | string | [Java distribution](https://github.com/actions/setup-java#supported-distributions) to be installed | +| java-version | ❌ | 11 | string | Java version to be installed | +| working-directory | ❌ | "." | string | Working directory of your Maven artifacts | +| download-lfs-files | ❌ | false | boolean | Whether the Git checkout action should resolve LFS files or not | +| command | ❌ | test | string | Command to run tests with | ## Usage diff --git a/actions/kustomize-deploy/README.md b/actions/kustomize-deploy/README.md index f44e9b456..66218db0b 100644 --- a/actions/kustomize-deploy/README.md +++ b/actions/kustomize-deploy/README.md @@ -10,8 +10,8 @@ Create a `kustomization.yaml` file for your deployment. | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :----: | -------------------------------------------------- | -| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | -| timeout | ❌ | 60 | string | Time out(in seconds) for CustomResourceDefinitions | +| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | +| timeout | ❌ | 60 | string | Time out(in seconds) for CustomResourceDefinitions | ## Usage diff --git a/actions/kustomize-destroy/README.md b/actions/kustomize-destroy/README.md index 8e4bd3a6d..219fcabda 100644 --- a/actions/kustomize-destroy/README.md +++ b/actions/kustomize-destroy/README.md @@ -6,7 +6,7 @@ This action will destroy a `kustomization.yaml` file on a Kubernetes cluster. | Name | Required | Default Value | Type | Description | | ------------------ | :------: | :-----------: | :----: | ----------------------------------------------- | -| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | +| kustomization-path | ✅ | - | string | Path to the root directory of the kustomization | ## Usage diff --git a/actions/port-forward/README.md b/actions/port-forward/README.md index 269d9dbbb..84af96300 100644 --- a/actions/port-forward/README.md +++ b/actions/port-forward/README.md @@ -6,11 +6,11 @@ This action creates a port forward for a Kubernetes service and keeps it open in | Name | Required | Default Value | Type | Description | | --------------- | :------: | :-----------: | :----: | ------------------------------------------- | -| namespace | ✅ | - | string | Kubernetes namespace | -| port | ✅ | - | string | Port to be forwarded | -| service | ✅ | - | string | Name of Kubernetes service | -| kubectl-version | ❌ | latest | string | kubectl version, e.g. `v1.23.0` or `latest` | -| timeout | ❌ | 30 | string | Timeout in seconds | +| namespace | ✅ | - | string | Kubernetes namespace | +| port | ✅ | - | string | Port to be forwarded | +| service | ✅ | - | string | Name of Kubernetes service | +| kubectl-version | ❌ | latest | string | kubectl version, e.g. `v1.23.0` or `latest` | +| timeout | ❌ | 30 | string | Timeout in seconds | ## Usage diff --git a/actions/python-poetry-bump-version/README.md b/actions/python-poetry-bump-version/README.md index 487eeca18..e8eed3e08 100644 --- a/actions/python-poetry-bump-version/README.md +++ b/actions/python-poetry-bump-version/README.md @@ -12,10 +12,10 @@ This action uses another composite action listed below: | Name | Required | Default Value | Type | Description | | ----------------- | :------: | :-----------: | :---------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------- | -| release-type | ✅ | - | string | Scope of the release, see the official [documentation of Poetry](https://python-poetry.org/docs/cli/#version) for possible values | -| python-version | ❌ | 3.10 | number | The Python version for setting up Poetry. | -| poetry-version | ❌ | 1.2.2 | number | The Poetry version to be installed. | -| working-directory | ❌ | . | The root directory of the Poetry project. | | +| release-type | ✅ | - | string | Scope of the release, see the official [documentation of Poetry](https://python-poetry.org/docs/cli/#version) for possible values | +| python-version | ❌ | 3.10 | number | The Python version for setting up Poetry. | +| poetry-version | ❌ | 1.2.2 | number | The Poetry version to be installed. | +| working-directory | ❌ | . | The root directory of the Poetry project. | | ## Output Parameters diff --git a/actions/python-poetry-publish-pypi/README.md b/actions/python-poetry-publish-pypi/README.md index dda6056e6..f015eada2 100644 --- a/actions/python-poetry-publish-pypi/README.md +++ b/actions/python-poetry-publish-pypi/README.md @@ -6,9 +6,9 @@ This composite action uses Poetry to build and publish your Python packages eith | Name | Required | Default Value | Description | | ----------------- | :------: | :-----------: | ---------------------------------------------------------------------------------------------------- | -| pypi-token | ✅ | - | The (Test)PyPI API token for publishing packages | -| publish-to-test | ❌ | true | If set to true, the packages are published to TestPyPI other wise the packages are published to PyPI | -| working-directory | ❌ | "./" | The working directory of your Python package. | +| pypi-token | ✅ | - | The (Test)PyPI API token for publishing packages | +| publish-to-test | ❌ | true | If set to true, the packages are published to TestPyPI other wise the packages are published to PyPI | +| working-directory | ❌ | "./" | The working directory of your Python package. | ## Usage diff --git a/actions/python-poetry-publish/README.md b/actions/python-poetry-publish/README.md index bd8a421e0..fe2d8c179 100644 --- a/actions/python-poetry-publish/README.md +++ b/actions/python-poetry-publish/README.md @@ -6,11 +6,11 @@ This composite action uses Poetry to build and publish your Python packages to a | Name | Required | Default Value | Description | | ----------------- | :------: | :-----------: | -------------------------------------------------- | -| index-name | ✅ | - | The package index name for publishing packages | -| index-url | ✅ | - | The package index url for publishing packages | -| index-username | ✅ | - | The package index username for publishing packages | -| index-password | ✅ | - | The package index password for publishing packages | -| working-directory | ❌ | "./" | The working directory of your Python package. | +| index-name | ✅ | - | The package index name for publishing packages | +| index-url | ✅ | - | The package index url for publishing packages | +| index-username | ✅ | - | The package index username for publishing packages | +| index-password | ✅ | - | The package index password for publishing packages | +| working-directory | ❌ | "./" | The working directory of your Python package. | ## Usage diff --git a/actions/python-setup-poetry/README.md b/actions/python-setup-poetry/README.md index 2c40e2afe..4022cde55 100644 --- a/actions/python-setup-poetry/README.md +++ b/actions/python-setup-poetry/README.md @@ -6,9 +6,9 @@ This composite action sets up Poetry for the given input version. It supports ca | Name | Required | Default Value | Description | | ----------------- | :------: | :-----------: | ------------------------------------------------------ | -| python-version | ❌ | 3.10 | The Python version for the Poetry virtual environment. | -| poetry-version | ❌ | 1.2.2 | The Poetry version to be installed. | -| working-directory | ❌ | . | The root directory of the Poetry project. | +| python-version | ❌ | 3.10 | The Python version for the Poetry virtual environment. | +| poetry-version | ❌ | 1.2.2 | The Poetry version to be installed. | +| working-directory | ❌ | . | The root directory of the Poetry project. | ## Usage diff --git a/actions/setup-credentials/README.md b/actions/setup-credentials/README.md index d6223bccf..75e00a5df 100644 --- a/actions/setup-credentials/README.md +++ b/actions/setup-credentials/README.md @@ -6,11 +6,11 @@ This action will set up authentication for GCloud and a Google Kubernetes Engine | Name | Required | Default Value | Type | Description | | ------------------- | :------: | :-----------: | :----: | ----------------------------------------------------------------------------------------- | -| gke-service-account | ✅ | - | string | The service account key for accessing the Google Kubernetes Engine cluster | -| gke-project | ✅ | - | string | The name of the Google Cloud project that the Google Kubernetes Engine cluster belongs to | -| gke-region | ✅ | - | string | The name of the Google Cloud region that the Google Kubernetes Engine cluster belongs to | -| gke-cluster | ✅ | - | string | The name of the Google Kubernetes engine cluster | -| gcloud-sdk-version | ❌ | 376.0.0 | string | The Google Cloud SDK version to install | +| gke-service-account | ✅ | - | string | The service account key for accessing the Google Kubernetes Engine cluster | +| gke-project | ✅ | - | string | The name of the Google Cloud project that the Google Kubernetes Engine cluster belongs to | +| gke-region | ✅ | - | string | The name of the Google Cloud region that the Google Kubernetes Engine cluster belongs to | +| gke-cluster | ✅ | - | string | The name of the Google Kubernetes engine cluster | +| gcloud-sdk-version | ❌ | 376.0.0 | string | The Google Cloud SDK version to install | ## Usage diff --git a/actions/substitute-envs/README.md b/actions/substitute-envs/README.md index 96ce59252..641231384 100644 --- a/actions/substitute-envs/README.md +++ b/actions/substitute-envs/README.md @@ -6,7 +6,7 @@ This action will recursively substitute environment variables in a given directo | Name | Required | Default Value | Type | Description | | ---- | :------: | :-----------: | :----: | ------------------------------------------------------------ | -| path | ✅ | - | string | Path to the directory to substitute environment variables in | +| path | ✅ | - | string | Path to the directory to substitute environment variables in | ## Output Parameters diff --git a/actions/tag-and-release/README.md b/actions/tag-and-release/README.md index bcc53cbf9..fb2f8966d 100644 --- a/actions/tag-and-release/README.md +++ b/actions/tag-and-release/README.md @@ -12,12 +12,12 @@ This action uses another composite action listed below: | Name | Required | Default Value | Description | | --------------- | :------: | :-----------: | ------------------------------------------------- | -| tag | ✅ | - | The version of the tag to be released, e.g. 1.0.0 | -| github-username | ✅ | - | The GitHub username for committing the changes | -| github-email | ✅ | - | The GitHub email for committing the changes | -| github-token | ✅ | - | The GitHub token for committing the changes | -| release-title | ✅ | - | Title for the GitHub release | -| release-body | ❌ | - | Description for the GitHub release | +| tag | ✅ | - | The version of the tag to be released, e.g. 1.0.0 | +| github-username | ✅ | - | The GitHub username for committing the changes | +| github-email | ✅ | - | The GitHub email for committing the changes | +| github-token | ✅ | - | The GitHub token for committing the changes | +| release-title | ✅ | - | Title for the GitHub release | +| release-body | ❌ | - | Description for the GitHub release | ## Usage diff --git a/docs/references/actions/action-lint/Variables.md b/docs/references/actions/action-lint/Variables.md index 8efb1ca14..4e104e075 100644 --- a/docs/references/actions/action-lint/Variables.md +++ b/docs/references/actions/action-lint/Variables.md @@ -1,16 +1,20 @@ # Refenrences action-lint composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|-------------|--------------------------------------------| -| action-lint-version | string | false | `"v1.6.22"` | The action lint repository version to use. | -| ref | string | false | | The ref name to checkout the repository. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ----------- | ------------------------------------------ | +| action-lint-version | string | false | `"v1.6.22"` | The action lint repository version to use. | +| ref | string | false | | The ref name to checkout the repository. | + ## Outputs + No outputs. + diff --git a/docs/references/actions/bump-version/Variables.md b/docs/references/actions/bump-version/Variables.md index 6a7804caa..e69de29bb 100644 --- a/docs/references/actions/bump-version/Variables.md +++ b/docs/references/actions/bump-version/Variables.md @@ -1,22 +0,0 @@ -# Refenrences bump-version composite action -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------|-------------------------------------------------------| -| new-version | string | false | | | -| release-type | string | true | | The type of the release (major, minor or patch). | -| working-directory | string | false | `"."` | The directory containing the `.bumpversion.cfg` file. | - - -## Outputs - - - -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|--------------------------------------------------| -| old-version | string | The old version in your `.bumpversion.cfg` file. | -| release-version | string | The bumped version of your project. | - - diff --git a/docs/references/actions/changelog-generate/Variables.md b/docs/references/actions/changelog-generate/Variables.md index 29bfd8900..e69de29bb 100644 --- a/docs/references/actions/changelog-generate/Variables.md +++ b/docs/references/actions/changelog-generate/Variables.md @@ -1,27 +0,0 @@ -# Refenrences changelog-generate composite action -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------------|--------|----------|------------------|----------------------------------------------------------------| -| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | -| commit-mode | string | false | `"false"` | Special configuration for projects which work without PRs. | -| config | string | false | | Path to the changelog config JSON file | -| fetch-release-information | string | false | `"false"` | Will enable fetching additional release information from tags. | -| fetch-reviewers | string | false | `"false"` | Will enable fetching the users/reviewers who approved the PR | -| github-token | string | true | | The GitHub token for committing the changes. | -| new-tag | string | true | | Version after bump | -| old-tag | string | false | | Previous version. Let empty for releases | - - -## Outputs - - - -| OUTPUT | TYPE | DESCRIPTION | -|------------------|--------|-------------------------------------------------------| -| merged-changelog | string | Changelog containing listing of all single changelogs | -| single-changelog | string | Changelog containing changes of the latest tag | - - diff --git a/docs/references/actions/checkout/Variables.md b/docs/references/actions/checkout/Variables.md index 725aae547..7491be196 100644 --- a/docs/references/actions/checkout/Variables.md +++ b/docs/references/actions/checkout/Variables.md @@ -1,25 +1,53 @@ # Refenrences checkout composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|------------------------------|-------------------------------------------------------------------------------| -| cache | string | false | `"true"` | Describes if the repository is using any LFS files | -| fetch-depth | string | false | `"1"` | Number of commits to fetch. 0 indicates all history for all branches and tags | -| lfs | string | false | `"false"` | Describes if the repository is using any LFS files | -| persist-credentials | string | false | `"true"` | Whether to configure the token or SSH key with the local git config | -| ref | string | false | | The branch, tag or SHA to checkout | -| repository | string | false | `"${{ github.repository }}"` | The repository name with owner | -| token | string | false | `"${{ github.token }}"` | Personal access token (PAT) used to fetch the repository | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ---------------------------- | ----------------------------------------------------------------------------- | +| cache | string | false | `"true"` | Describes if the repository is using any LFS files | +| fetch-depth | string | false | `"1"` | Number of commits to fetch. 0 indicates all history for all branches and tags | +| lfs | string | false | `"false"` | Describes if the repository is using any LFS files | +| persist-credentials | string | false | `"true"` | Whether to configure the token or SSH key with the local git config | +| ref | string | false | | The branch, tag or SHA to checkout | +| repository | string | false | `"${{ github.repository }}"` | The repository name with owner | +| token | string | false | `"${{ github.token }}"` | Personal access token (PAT) used to fetch the repository | + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ---------------------------- | ----------------------------------------------------------------------------- | +| cache | string | false | `"true"` | Describes if the repository is using any LFS files | +| fetch-depth | string | false | `"1"` | Number of commits to fetch. 0 indicates all history for all branches and tags | +| lfs | string | false | `"false"` | Describes if the repository is using any LFS files | +| persist-credentials | string | false | `"true"` | Whether to configure the token or SSH key with the local git config | +| ref | string | false | | The branch, tag or SHA to checkout | +| repository | string | false | `"${{ github.repository }}"` | The repository name with owner | +| token | string | false | `"${{ github.token }}"` | Personal access token (PAT) used to fetch the repository | + + + +## Outputs + + + +| OUTPUT | TYPE | DESCRIPTION | +| ------------- | ------ | ---------------------------------------------------------------- | +| lfs-cache-hit | string | A boolean value to indicate an exact match was found for the key | + + + ## Outputs -| OUTPUT | TYPE | DESCRIPTION | -|---------------|--------|------------------------------------------------------------------| +| OUTPUT | TYPE | DESCRIPTION | +| ------------- | ------ | ---------------------------------------------------------------- | | lfs-cache-hit | string | A boolean value to indicate an exact match was found for the key | diff --git a/docs/references/actions/commit-and-push/Variables.md b/docs/references/actions/commit-and-push/Variables.md index 3e0ba0f2b..af4e4f45b 100644 --- a/docs/references/actions/commit-and-push/Variables.md +++ b/docs/references/actions/commit-and-push/Variables.md @@ -1,21 +1,73 @@ # Refenrences commit-and-push composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------------------------------------------|-----------------------------------------------------| -| add-untracked | string | false | `"false"` | Whether to add untracked files to commit. | -| commit-message | string | true | | The commit message. | -| github-email | string | true | | The GitHub email for committing the changes. | -| github-token | string | true | | The GitHub token for committing the changes. | -| github-username | string | true | | The GitHub username for committing the changes. | -| pass-empty-commit | string | false | `"false"` | Whether to exit with code 0 when nothing to commit. | -| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to commit and push the files on. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------------------------------------------- | --------------------------------------------------- | +| add-untracked | string | false | `"false"` | Whether to add untracked files to commit. | +| commit-message | string | true | | The commit message. | +| github-email | string | true | | The GitHub email for committing the changes. | +| github-token | string | true | | The GitHub token for committing the changes. | +| github-username | string | true | | The GitHub username for committing the changes. | +| pass-empty-commit | string | false | `"false"` | Whether to exit with code 0 when nothing to commit. | +| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to commit and push the files on. | + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------------------------------------------- | --------------------------------------------------- | +| add-untracked | string | false | `"false"` | Whether to add untracked files to commit. | +| commit-message | string | true | | The commit message. | +| github-email | string | true | | The GitHub email for committing the changes. | +| github-token | string | true | | The GitHub token for committing the changes. | +| github-username | string | true | | The GitHub username for committing the changes. | +| pass-empty-commit | string | false | `"false"` | Whether to exit with code 0 when nothing to commit. | +| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to commit and push the files on. | + + + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------------------------------------------- | --------------------------------------------------- | +| add-untracked | string | false | `"false"` | Whether to add untracked files to commit. | +| commit-message | string | true | | The commit message. | +| github-email | string | true | | The GitHub email for committing the changes. | +| github-token | string | true | | The GitHub token for committing the changes. | +| github-username | string | true | | The GitHub username for committing the changes. | +| pass-empty-commit | string | false | `"false"` | Whether to exit with code 0 when nothing to commit. | +| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to commit and push the files on. | + + + +## Outputs + + + +No outputs. + + + ## Outputs + No outputs. + + + +## Outputs + + + +No outputs. + diff --git a/docs/references/actions/docker-build/Variables.md b/docs/references/actions/docker-build/Variables.md index e0f8ab24d..e4d1db83c 100644 --- a/docs/references/actions/docker-build/Variables.md +++ b/docs/references/actions/docker-build/Variables.md @@ -1,20 +1,24 @@ # Refenrences docker-build composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| -| docker-context | string | false | `"."` | The docker context. | -| dockerfile-path | string | false | `"Dockerfile"` | Path to the Dockerfile. | -| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact (Default is 'image-artifact'). | -| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | -| retention-days | string | false | `"1"` | Number of days the image artifact should be stored on GitHub. | -| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| docker-context | string | false | `"."` | The docker context. | +| dockerfile-path | string | false | `"Dockerfile"` | Path to the Dockerfile. | +| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact (Default is 'image-artifact'). | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| retention-days | string | false | `"1"` | Number of days the image artifact should be stored on GitHub. | +| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | + ## Outputs + No outputs. + diff --git a/docs/references/actions/docker-publish/Variables.md b/docs/references/actions/docker-publish/Variables.md index 8fbdff4dd..0267c0776 100644 --- a/docs/references/actions/docker-publish/Variables.md +++ b/docs/references/actions/docker-publish/Variables.md @@ -1,20 +1,24 @@ # Refenrences docker-publish composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| -| docker-registry | string | false | | Host where the image should be pushed to. | -| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. | -| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | -| image-namespace | string | false | | Namespace of Docker image. | -| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | -| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | +| docker-registry | string | false | | Host where the image should be pushed to. | +| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| image-namespace | string | false | | Namespace of Docker image. | +| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | +| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | + ## Outputs + No outputs. + diff --git a/docs/references/actions/docker-push/Variables.md b/docs/references/actions/docker-push/Variables.md index 124fea84e..d2055902b 100644 --- a/docs/references/actions/docker-push/Variables.md +++ b/docs/references/actions/docker-push/Variables.md @@ -1,19 +1,45 @@ # Refenrences docker-push composite action + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------------------------------------------------ | -------------------------------------------- | +| docker-registry | string | false | | Host where the image should be pushed to. | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| image-namespace | string | false | | Namespace of Docker image. | +| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | +| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | + + + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|--------------------------------------------------------|----------------------------------------------| -| docker-registry | string | false | | Host where the image should be pushed to. | -| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | -| image-namespace | string | false | | Namespace of Docker image. | -| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | -| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------------------------------------------------ | -------------------------------------------- | +| docker-registry | string | false | | Host where the image should be pushed to. | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| image-namespace | string | false | | Namespace of Docker image. | +| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | +| working-directory | string | false | `"."` | Working directory for your Docker artifacts. | + ## Outputs + No outputs. + + + +## Outputs + + + +No outputs. + diff --git a/docs/references/actions/helm-deploy/Variables.md b/docs/references/actions/helm-deploy/Variables.md index 8353ca16e..87855f54c 100644 --- a/docs/references/actions/helm-deploy/Variables.md +++ b/docs/references/actions/helm-deploy/Variables.md @@ -1,25 +1,57 @@ # Refenrences helm-deploy composite action + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | -------- | ----------------------------------------------------------------------------------------------- | +| chart | string | true | | Helm chart to deploy | +| chart-version | string | false | | Chart Version | +| namespace | string | true | | K8s namespace to deploy in | +| post-renderer | string | false | | File path as string for a Helm post renderer | +| release-name | string | true | | Helm release name | +| repository-name | string | false | | Helm repository name | +| repository-password | string | false | | Password for the login to the repository | +| repository-url | string | false | | Url of the repository | +| repository-username | string | false | | User for the login to the repository | +| timeout | string | false | `"1200"` | Timeout for the Helm command in seconds | +| values-yaml | string | true | | File path as string for a single Helm value file or as json array for multiple Helm value files | + + + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|----------|-------------------------------------------------------------------------------------------------| -| chart | string | true | | Helm chart to deploy | -| chart-version | string | false | | Chart Version | -| namespace | string | true | | K8s namespace to deploy in | -| post-renderer | string | false | | File path as string for a Helm post renderer | -| release-name | string | true | | Helm release name | -| repository-name | string | false | | Helm repository name | -| repository-password | string | false | | Password for the login to the repository | -| repository-url | string | false | | Url of the repository | -| repository-username | string | false | | User for the login to the repository | -| timeout | string | false | `"1200"` | Timeout for the Helm command in seconds | -| values-yaml | string | true | | File path as string for a single Helm value file or as json array for multiple Helm value files | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | -------- | ----------------------------------------------------------------------------------------------- | +| chart | string | true | | Helm chart to deploy | +| chart-version | string | false | | Chart Version | +| namespace | string | true | | K8s namespace to deploy in | +| post-renderer | string | false | | File path as string for a Helm post renderer | +| release-name | string | true | | Helm release name | +| repository-name | string | false | | Helm repository name | +| repository-password | string | false | | Password for the login to the repository | +| repository-url | string | false | | Url of the repository | +| repository-username | string | false | | User for the login to the repository | +| timeout | string | false | `"1200"` | Timeout for the Helm command in seconds | +| values-yaml | string | true | | File path as string for a single Helm value file or as json array for multiple Helm value files | + ## Outputs + No outputs. + + + +## Outputs + + + +No outputs. + diff --git a/docs/references/actions/helm-destroy/Variables.md b/docs/references/actions/helm-destroy/Variables.md index 72d8d22fa..fcbdf804b 100644 --- a/docs/references/actions/helm-destroy/Variables.md +++ b/docs/references/actions/helm-destroy/Variables.md @@ -1,16 +1,20 @@ # Refenrences helm-destroy composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------|--------|----------|---------|-----------------------------| -| namespace | string | true | | K8s namespace to destroy in | -| release-name | string | true | | Helm release name | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------ | ------ | -------- | ------- | --------------------------- | +| namespace | string | true | | K8s namespace to destroy in | +| release-name | string | true | | Helm release name | + ## Outputs + No outputs. + diff --git a/docs/references/actions/helm-lint/Variables.md b/docs/references/actions/helm-lint/Variables.md index 692ece49c..bfaf4ab5b 100644 --- a/docs/references/actions/helm-lint/Variables.md +++ b/docs/references/actions/helm-lint/Variables.md @@ -1,17 +1,21 @@ # Refenrences helm-lint composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|------------------|--------|----------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| helm-version | string | false | `"v3.10.1"` | The Helm version. | -| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (For an example see https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | -| ref | string | false | `"${{ github.ref_name }}"` | The ref name to checkout the repository. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ---------------- | ------ | -------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| helm-version | string | false | `"v3.10.1"` | The Helm version. | +| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (For an example see https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | +| ref | string | false | `"${{ github.ref_name }}"` | The ref name to checkout the repository. | + ## Outputs + No outputs. + diff --git a/docs/references/actions/helm-package/Variables.md b/docs/references/actions/helm-package/Variables.md index 39d6f3681..59d48e306 100644 --- a/docs/references/actions/helm-package/Variables.md +++ b/docs/references/actions/helm-package/Variables.md @@ -1,16 +1,23 @@ -# Refenrences helm-package composite action ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------|--------|----------|-------------|------------------------------------------| -| charts-dir | string | false | `"."` | The directory containing the Helm chart. | -| helm-version | string | false | `"v3.10.1"` | The Helm version. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------ | ------ | -------- | ----------- | ---------------------------------------- | +| charts-dir | string | false | `"."` | The directory containing the Helm chart. | +| helm-version | string | false | `"v3.10.1"` | The Helm version. | + ## Outputs + No outputs. + + + +-> +No outputs. + diff --git a/docs/references/actions/helm-setup/Variables.md b/docs/references/actions/helm-setup/Variables.md index cfccaa5bd..2bc2ccc97 100644 --- a/docs/references/actions/helm-setup/Variables.md +++ b/docs/references/actions/helm-setup/Variables.md @@ -1,16 +1,20 @@ # Refenrences helm-setup composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-----------------|--------|----------|-------------|-----------------| -| helm-version | string | false | `"v3.10.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| --------------- | ------ | -------- | ----------- | --------------- | +| helm-version | string | false | `"v3.10.1"` | Helm version | +| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | + ## Outputs + No outputs. + diff --git a/docs/references/actions/java-gradle-assess-code-quality/Variables.md b/docs/references/actions/java-gradle-assess-code-quality/Variables.md index 5fcbbaa36..3cfb814ff 100644 --- a/docs/references/actions/java-gradle-assess-code-quality/Variables.md +++ b/docs/references/actions/java-gradle-assess-code-quality/Variables.md @@ -1,25 +1,61 @@ # Refenrences java-gradle-assess-code-quality composite action + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------- | ------ | -------- | ------------- | ----------------------------------------------------------------------------------- | +| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| signing-key-id | string | false | | Key id for signing the Sonatype publication. | +| signing-password | string | false | | Password for signing the Sonatype publication. | +| signing-secret-key-ring | string | false | | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | string | false | | Organization for Sonarcloud. | +| sonar-token | string | false | | Token for Sonarcloud. | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + + + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------|--------|----------|---------------|-------------------------------------------------------------------------------------| -| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| signing-key-id | string | false | | Key id for signing the Sonatype publication. | -| signing-password | string | false | | Password for signing the Sonatype publication. | -| signing-secret-key-ring | string | false | | Key ring (base64 encoded) for signing the Sonatype publication. | -| sonar-organization | string | false | | Organization for Sonarcloud. | -| sonar-token | string | false | | Token for Sonarcloud. | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------- | ------ | -------- | ------------- | ----------------------------------------------------------------------------------- | +| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| signing-key-id | string | false | | Key id for signing the Sonatype publication. | +| signing-password | string | false | | Password for signing the Sonatype publication. | +| signing-secret-key-ring | string | false | | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | string | false | | Organization for Sonarcloud. | +| sonar-token | string | false | | Token for Sonarcloud. | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + + +## Outputs + + + +No outputs. + + + +## Inputs + +## Outputs diff --git a/docs/references/actions/java-gradle-build-jib/Variables.md b/docs/references/actions/java-gradle-build-jib/Variables.md index c25106680..8e1e89243 100644 --- a/docs/references/actions/java-gradle-build-jib/Variables.md +++ b/docs/references/actions/java-gradle-build-jib/Variables.md @@ -1,24 +1,20 @@ # Refenrences java-gradle-build-jib composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| image-artifact-name | string | false | `"image-artifact"` | Artifact name to upload tarball image, see https://github.com/actions/upload-artifact | -| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| jib-from-image | string | false | | The Jib base image to use | -| subproject | string | false | | The Gradle subproject for which the tarball image should be built (If not specified, a tarball image for the root project will be built) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| image-artifact-name | string | false | `"image-artifact"` | Artifact name to upload tarball image, see https://github.com/actions/upload-artifact | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| jib-from-image | string | false | | The Jib base image to use | +| subproject | string | false | | The Gradle subproject for which the tarball image should be built (If not specified, a tarball image for the root project will be built) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-build/Variables.md b/docs/references/actions/java-gradle-build/Variables.md index 0bc2aaee6..c0f8f1775 100644 --- a/docs/references/actions/java-gradle-build/Variables.md +++ b/docs/references/actions/java-gradle-build/Variables.md @@ -1,20 +1,24 @@ # Refenrences java-gradle-build composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------| -| build-artifact-name | string | false | `"build-artifact"` | Artifact name that is used for uploading build artifacts, see https://github.com/actions/upload-artifact (Default is build-artifact). | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | +| build-artifact-name | string | false | `"build-artifact"` | Artifact name that is used for uploading build artifacts, see https://github.com/actions/upload-artifact (Default is build-artifact). | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/java-gradle-publish-plugin/Variables.md b/docs/references/actions/java-gradle-publish-plugin/Variables.md index 33071e908..85a4fb249 100644 --- a/docs/references/actions/java-gradle-publish-plugin/Variables.md +++ b/docs/references/actions/java-gradle-publish-plugin/Variables.md @@ -1,29 +1 @@ # Refenrences java-gradle-publish-plugin composite action -## Outputs - - -No outputs. - -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------|--------|----------|---------------|-----------------------------------------------------------------| -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-publish-key | string | true | | Key for publishing to Gradle Plugin Portal. | -| gradle-publish-secret | string | true | | Secret for publishing to Gradle Plugin Portal. | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| signing-key-id | string | true | | Key id for signing the Sonatype publication. | -| signing-password | string | true | | Password for signing the Sonatype publication. | -| signing-secret-key-ring | string | true | | Key ring (base64 encoded) for signing the Sonatype publication. | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-publish/Variables.md b/docs/references/actions/java-gradle-publish/Variables.md index b7adc3d28..c5fd2b121 100644 --- a/docs/references/actions/java-gradle-publish/Variables.md +++ b/docs/references/actions/java-gradle-publish/Variables.md @@ -1,24 +1,9 @@ # Refenrences java-gradle-publish composite action -## Inputs - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------|--------|----------|---------------|-----------------------------------------------------------------| -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| ossrh-password | string | true | | Password for signing into Sonatype repository. | -| ossrh-username | string | true | | Username for signing into Sonatype repository. | -| signing-key-id | string | true | | Key id for signing the Sonatype publication. | -| signing-password | string | true | | Password for signing the Sonatype publication. | -| signing-secret-key-ring | string | true | | Key ring (base64 encoded) for signing the Sonatype publication. | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | - - ## Outputs + No outputs. + diff --git a/docs/references/actions/java-gradle-release-github/Variables.md b/docs/references/actions/java-gradle-release-github/Variables.md index 583f0d349..ffc838e14 100644 --- a/docs/references/actions/java-gradle-release-github/Variables.md +++ b/docs/references/actions/java-gradle-release-github/Variables.md @@ -1,22 +1,26 @@ # Refenrences java-gradle-release-github composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|------------------|-------------------------------------------------------------| -| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | -| github-token | string | true | | GitHub token for requesting changes from API. | -| github-username | string | true | | GitHub username for requesting changes from API. | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ---------------- | ----------------------------------------------------------- | +| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | +| github-token | string | true | | GitHub token for requesting changes from API. | +| github-username | string | true | | GitHub username for requesting changes from API. | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/java-gradle-release/Variables.md b/docs/references/actions/java-gradle-release/Variables.md index dd28c57bd..2fc42d848 100644 --- a/docs/references/actions/java-gradle-release/Variables.md +++ b/docs/references/actions/java-gradle-release/Variables.md @@ -1,37 +1,30 @@ # Refenrences java-gradle-release composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|------------------|-------------------------------------------------------------| -| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | -| github-email | string | true | | GitHub email for requesting changes from API. | -| github-token | string | true | | GitHub token for requesting changes from API. | -| github-username | string | true | | GitHub username for requesting changes from API. | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| release-type | string | true | | Scope of the release | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ---------------- | ----------------------------------------------------------- | +| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | +| github-email | string | true | | GitHub email for requesting changes from API. | +| github-token | string | true | | GitHub token for requesting changes from API. | +| github-username | string | true | | GitHub username for requesting changes from API. | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| release-type | string | true | | Scope of the release | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | -## Outputs - - -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| -| release-version | string | The bumped version of your release. | - - ## Outputs -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| +| OUTPUT | TYPE | DESCRIPTION | +| --------------- | ------ | ----------------------------------- | | release-version | string | The bumped version of your release. | diff --git a/docs/references/actions/java-gradle-setup/Variables.md b/docs/references/actions/java-gradle-setup/Variables.md index aed06248e..75fa9f5f0 100644 --- a/docs/references/actions/java-gradle-setup/Variables.md +++ b/docs/references/actions/java-gradle-setup/Variables.md @@ -1,20 +1,30 @@ # Refenrences java-gradle-setup composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-------------------------------------------------------------| -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------- | ----------------------------------------------------------- | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | + ## Outputs + No outputs. + + ## Inputs + +## Outputs + +## Inputs + ## Outputs diff --git a/docs/references/actions/java-gradle-test/Variables.md b/docs/references/actions/java-gradle-test/Variables.md index 7b278e39e..25a05abfa 100644 --- a/docs/references/actions/java-gradle-test/Variables.md +++ b/docs/references/actions/java-gradle-test/Variables.md @@ -1,20 +1,24 @@ # Refenrences java-gradle-test composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|---------------|-------------------------------------------------------------------------------------| -| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | -| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ------------- | ----------------------------------------------------------------------------------- | +| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| gradle-cache | string | false | `"true"` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/java-maven-build/Variables.md b/docs/references/actions/java-maven-build/Variables.md index e5a39395e..86f9c6c0b 100644 --- a/docs/references/actions/java-maven-build/Variables.md +++ b/docs/references/actions/java-maven-build/Variables.md @@ -1,19 +1,23 @@ # Refenrences java-maven-build composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-----------------------------------------------------------| -| command | string | false | `"compile"` | Command to run build with. (Default is compile) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | -| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------- | --------------------------------------------------------- | +| command | string | false | `"compile"` | Command to run build with. (Default is compile) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| maven-version | string | true | | Maven version to be installed. | +| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/java-maven-release/Variables.md b/docs/references/actions/java-maven-release/Variables.md index 68d39f5db..bfdfc4165 100644 --- a/docs/references/actions/java-maven-release/Variables.md +++ b/docs/references/actions/java-maven-release/Variables.md @@ -1,76 +1,28 @@ # Refenrences java-maven-release composite action -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-----------------------------------------------------------| -| github-email | string | true | | GitHub email for requesting changes from API. | -| github-token | string | true | | GitHub token for requesting changes from API. | -| github-username | string | true | | GitHub username for requesting changes from API. | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | -| release-type | string | true | | Scope of the release | -| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | - - -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-----------------------------------------------------------| -| github-email | string | true | | GitHub email for requesting changes from API. | -| github-token | string | true | | GitHub token for requesting changes from API. | -| github-username | string | true | | GitHub username for requesting changes from API. | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | -| release-type | string | true | | Scope of the release | -| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | - - -## Outputs - - -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| -| release-version | string | The bumped version of your release. | - - ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-----------------------------------------------------------| -| github-email | string | true | | GitHub email for requesting changes from API. | -| github-token | string | true | | GitHub token for requesting changes from API. | -| github-username | string | true | | GitHub username for requesting changes from API. | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | -| release-type | string | true | | Scope of the release | -| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------------- | --------------------------------------------------------- | +| github-email | string | true | | GitHub email for requesting changes from API. | +| github-token | string | true | | GitHub token for requesting changes from API. | +| github-username | string | true | | GitHub username for requesting changes from API. | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| maven-version | string | true | | Maven version to be installed. | +| release-type | string | true | | Scope of the release | +| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | -## Outputs - - -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| -| release-version | string | The bumped version of your release. | - - ## Outputs -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| +| OUTPUT | TYPE | DESCRIPTION | +| --------------- | ------ | ----------------------------------- | | release-version | string | The bumped version of your release. | diff --git a/docs/references/actions/java-maven-setup/Variables.md b/docs/references/actions/java-maven-setup/Variables.md index 3c8cb23fd..d45471f9e 100644 --- a/docs/references/actions/java-maven-setup/Variables.md +++ b/docs/references/actions/java-maven-setup/Variables.md @@ -1,22 +1 @@ # Refenrences java-maven-setup composite action -## Outputs - - -No outputs. - -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------------|-----------------------------------------------------------| -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-maven-test/Variables.md b/docs/references/actions/java-maven-test/Variables.md index bc436fa31..a2f55395f 100644 --- a/docs/references/actions/java-maven-test/Variables.md +++ b/docs/references/actions/java-maven-test/Variables.md @@ -1,20 +1,24 @@ # Refenrences java-maven-test composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|---------------|-------------------------------------------------------------------------------------| -| command | string | false | `"test"` | Command to run tests with. (Default is test) | -| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| maven-version | string | true | | Maven version to be installed. | -| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ------------- | ----------------------------------------------------------------------------------- | +| command | string | false | `"test"` | Command to run tests with. (Default is test) | +| download-lfs-files | string | false | `"false"` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| maven-version | string | true | | Maven version to be installed. | +| working-directory | string | false | `"."` | Working directory of your Maven artifacts. (Default is .) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/kustomize-deploy/Variables.md b/docs/references/actions/kustomize-deploy/Variables.md index 93b90b052..a28f6e266 100644 --- a/docs/references/actions/kustomize-deploy/Variables.md +++ b/docs/references/actions/kustomize-deploy/Variables.md @@ -1,16 +1,20 @@ # Refenrences kustomize-deploy composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|---------|----------------------------------------------------| -| kustomization-path | string | true | | Path to the root directory of the kustomization | -| timeout | string | false | `"60"` | Time out(in seconds) for CustomResourceDefinitions | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ------- | -------------------------------------------------- | +| kustomization-path | string | true | | Path to the root directory of the kustomization | +| timeout | string | false | `"60"` | Time out(in seconds) for CustomResourceDefinitions | + ## Outputs + No outputs. + diff --git a/docs/references/actions/kustomize-destroy/Variables.md b/docs/references/actions/kustomize-destroy/Variables.md index b7f16ba0f..10e274e43 100644 --- a/docs/references/actions/kustomize-destroy/Variables.md +++ b/docs/references/actions/kustomize-destroy/Variables.md @@ -1,15 +1,37 @@ # Refenrences kustomize-destroy composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|---------|-------------------------------------------------| -| kustomization-path | string | true | | Path to the root directory of the kustomization | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ------- | ----------------------------------------------- | +| kustomization-path | string | true | | Path to the root directory of the kustomization | + ## Outputs + No outputs. + + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ------- | ----------------------------------------------- | +| kustomization-path | string | true | | Path to the root directory of the kustomization | + + + +## Outputs + +## Outputs + +## Inputs + +## Outputs diff --git a/docs/references/actions/port-forward/Variables.md b/docs/references/actions/port-forward/Variables.md index e7c84682b..c04aeaf6d 100644 --- a/docs/references/actions/port-forward/Variables.md +++ b/docs/references/actions/port-forward/Variables.md @@ -1,19 +1,23 @@ # Refenrences port-forward composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-----------------|--------|----------|------------|---------------------------------------------| -| kubectl-version | string | false | `"latest"` | kubectl version, e.g. `v1.23.0` or `latest` | -| namespace | string | true | | Kubernetes namespace | -| port | string | true | | Port to be forwarded | -| service | string | true | | Name of Kubernetes service | -| timeout | string | false | `"30"` | Timeout for portfowrd | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| --------------- | ------ | -------- | ---------- | ------------------------------------------- | +| kubectl-version | string | false | `"latest"` | kubectl version, e.g. `v1.23.0` or `latest` | +| namespace | string | true | | Kubernetes namespace | +| port | string | true | | Port to be forwarded | +| service | string | true | | Name of Kubernetes service | +| timeout | string | false | `"30"` | Timeout for portfowrd | + ## Outputs + No outputs. + diff --git a/docs/references/actions/python-poetry-bump-version/Variables.md b/docs/references/actions/python-poetry-bump-version/Variables.md index b5335e2fd..8dfb7e55c 100644 --- a/docs/references/actions/python-poetry-bump-version/Variables.md +++ b/docs/references/actions/python-poetry-bump-version/Variables.md @@ -1,23 +1,25 @@ # Refenrences python-poetry-bump-version composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|-----------|------------------------------------------------------------------------------------------------------------------------| -| poetry-version | string | false | `"1.2.2"` | The Poetry version to be installed. | -| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. | -| release-type | string | true | | Scope of the release: patch, minor, major, or snapshot. See https://python-poetry.org/docs/cli/#version for reference. | -| working-directory | string | false | `"."` | The root directory of the Poetry project. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | +| poetry-version | string | false | `"1.2.2"` | The Poetry version to be installed. | +| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. | +| release-type | string | true | | Scope of the release: patch, minor, major, or snapshot. See https://python-poetry.org/docs/cli/#version for reference. | +| working-directory | string | false | `"."` | The root directory of the Poetry project. | + ## Outputs -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------| -| old-version | string | The old version of your package. | +| OUTPUT | TYPE | DESCRIPTION | +| --------------- | ------ | ----------------------------------- | +| old-version | string | The old version of your package. | | release-version | string | The bumped version of your package. | diff --git a/docs/references/actions/python-poetry-publish-pypi/Variables.md b/docs/references/actions/python-poetry-publish-pypi/Variables.md index f1b2a2446..4acd66b40 100644 --- a/docs/references/actions/python-poetry-publish-pypi/Variables.md +++ b/docs/references/actions/python-poetry-publish-pypi/Variables.md @@ -1,17 +1,21 @@ # Refenrences python-poetry-publish-pypi composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|----------|----------------------------------------------------------------------------| -| publish-to-test | string | false | `"true"` | If set to false, the packages are published to PyPI. (Default is true) | -| pypi-token | string | true | | The PyPI token for publishing packages. | -| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | -------- | -------------------------------------------------------------------------- | +| publish-to-test | string | false | `"true"` | If set to false, the packages are published to PyPI. (Default is true) | +| pypi-token | string | true | | The PyPI token for publishing packages. | +| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/python-poetry-publish/Variables.md b/docs/references/actions/python-poetry-publish/Variables.md index 7b4ff8a6a..1b30503be 100644 --- a/docs/references/actions/python-poetry-publish/Variables.md +++ b/docs/references/actions/python-poetry-publish/Variables.md @@ -1,19 +1,23 @@ # Refenrences python-poetry-publish composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|---------|----------------------------------------------------------------------------| -| index-name | string | true | | The package index name for publishing packages. | -| index-password | string | true | | The package index password for publishing packages. | -| index-url | string | true | | The package index url for publishing packages. | -| index-username | string | true | | The package index username for publishing packages. | -| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | +| index-name | string | true | | The package index name for publishing packages. | +| index-password | string | true | | The package index password for publishing packages. | +| index-url | string | true | | The package index url for publishing packages. | +| index-username | string | true | | The package index username for publishing packages. | +| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | + ## Outputs + No outputs. + diff --git a/docs/references/actions/python-setup-poetry/Variables.md b/docs/references/actions/python-setup-poetry/Variables.md index 4751c45f4..f05e7b5ef 100644 --- a/docs/references/actions/python-setup-poetry/Variables.md +++ b/docs/references/actions/python-setup-poetry/Variables.md @@ -1,17 +1,21 @@ # Refenrences python-setup-poetry composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|-----------|--------------------------------------------------------| -| poetry-version | string | false | `"1.2.2"` | The Poetry version to be installed. | -| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. | -| working-directory | string | false | `"."` | The root directory of the Poetry project. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | --------- | ------------------------------------------------------ | +| poetry-version | string | false | `"1.2.2"` | The Poetry version to be installed. | +| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. | +| working-directory | string | false | `"."` | The root directory of the Poetry project. | + ## Outputs + No outputs. + diff --git a/docs/references/actions/setup-credentials/Variables.md b/docs/references/actions/setup-credentials/Variables.md index c74726136..7b067e81a 100644 --- a/docs/references/actions/setup-credentials/Variables.md +++ b/docs/references/actions/setup-credentials/Variables.md @@ -1,19 +1,23 @@ # Refenrences setup-credentials composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|-------------|--------------------------------------------| -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| gke-cluster | string | true | | GKE cluster for authentication | -| gke-project | string | true | | GKE project id for authentication | -| gke-region | string | true | | GKE region for authentication | -| gke-service-account | string | true | | GKE service account key for authentication | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ----------- | ------------------------------------------ | +| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | +| gke-cluster | string | true | | GKE cluster for authentication | +| gke-project | string | true | | GKE project id for authentication | +| gke-region | string | true | | GKE region for authentication | +| gke-service-account | string | true | | GKE service account key for authentication | + ## Outputs + No outputs. + diff --git a/docs/references/actions/substitute-envs/Variables.md b/docs/references/actions/substitute-envs/Variables.md index d339a4a21..121821b97 100644 --- a/docs/references/actions/substitute-envs/Variables.md +++ b/docs/references/actions/substitute-envs/Variables.md @@ -1,19 +1,21 @@ # Refenrences substitute-envs composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------|--------|----------|---------|--------------------------------------------------------------| -| path | string | true | | Path to the directory to substitute environment variables in | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----- | ------ | -------- | ------- | ------------------------------------------------------------ | +| path | string | true | | Path to the directory to substitute environment variables in | + ## Outputs -| OUTPUT | TYPE | DESCRIPTION | -|--------|--------|----------------------------------------------------| -| path | string | Path to the temporary directory after substitution | +| OUTPUT | TYPE | DESCRIPTION | +| ------ | ------ | -------------------------------------------------- | +| path | string | Path to the temporary directory after substitution | diff --git a/docs/references/actions/tag-and-release/Variables.md b/docs/references/actions/tag-and-release/Variables.md index 2d1a45d25..3fff68190 100644 --- a/docs/references/actions/tag-and-release/Variables.md +++ b/docs/references/actions/tag-and-release/Variables.md @@ -1,20 +1,24 @@ # Refenrences tag-and-release composite action + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-----------------|--------|----------|---------|----------------------------------------------------| -| github-email | string | true | | The GitHub email for committing the changes. | -| github-token | string | true | | The GitHub token for committing the changes. | -| github-username | string | true | | The GitHub username for committing the changes. | -| release-body | string | false | | Description for the GitHub release. | -| release-title | string | true | | Title for the GitHub release. | -| tag | string | true | | The version of the tag to be released, e.g. 1.0.0. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| --------------- | ------ | -------- | ------- | -------------------------------------------------- | +| github-email | string | true | | The GitHub email for committing the changes. | +| github-token | string | true | | The GitHub token for committing the changes. | +| github-username | string | true | | The GitHub username for committing the changes. | +| release-body | string | false | | Description for the GitHub release. | +| release-title | string | true | | Title for the GitHub release. | +| tag | string | true | | The version of the tag to be released, e.g. 1.0.0. | + ## Outputs + No outputs. + diff --git a/docs/references/wokflows/bump-version-release/Variables.md b/docs/references/wokflows/bump-version-release/Variables.md index a4d587102..b1637929d 100644 --- a/docs/references/wokflows/bump-version-release/Variables.md +++ b/docs/references/wokflows/bump-version-release/Variables.md @@ -1,55 +1,37 @@ # Refenrences bump-version-release reusable Workflow -## Outputs - - - -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|-------------------------------------------------|--------------------------------------------------| -| old-version | `"${{ jobs.release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | -| release-version | `"${{ jobs.release.outputs.release-version }}"` | The bumped version. | - - -## Secrets - - -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | - - ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|---------|-----------------------------------------------------------------| -| changelog | boolean | false | `true` | Create changelog for release. | -| changelog-config | string | false | | Changelog config path. | -| release-type | string | true | | Scope of the release (major, minor or patch). | -| working-directory | string | false | `"."` | Working directory containing `.bumpversion.cfg`. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------- | +| changelog | boolean | false | `true` | Create changelog for release. | +| changelog-config | string | false | | Changelog config path. | +| release-type | string | true | | Scope of the release (major, minor or patch). | +| working-directory | string | false | `"."` | Working directory containing `.bumpversion.cfg`. (Default is .) | + ## Outputs -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|-------------------------------------------------|--------------------------------------------------| -| old-version | `"${{ jobs.release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | -| release-version | `"${{ jobs.release.outputs.release-version }}"` | The bumped version. | +| OUTPUT | VALUE | DESCRIPTION | +| --------------- | ----------------------------------------------- | ------------------------------------------------ | +| old-version | `"${{ jobs.release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | +| release-version | `"${{ jobs.release.outputs.release-version }}"` | The bumped version. | + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | ----------------------------------------------- | +| github-email | true | The GitHub email for committing the changes. | +| github-token | true | The GitHub token for committing the changes. | +| github-username | true | The GitHub username for committing the changes. | diff --git a/docs/references/wokflows/docker-build-and-publish/Variables.md b/docs/references/wokflows/docker-build-and-publish/Variables.md index a53c31136..3d6405e8f 100644 --- a/docs/references/wokflows/docker-build-and-publish/Variables.md +++ b/docs/references/wokflows/docker-build-and-publish/Variables.md @@ -1,35 +1,40 @@ # Refenrences docker-build-and-publish reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|---------------------|--------|----------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| -| docker-context | string | false | `"."` | The docker context. | -| docker-registry | string | false | | Host where the image should be pushed to. | -| dockerfile-path | string | false | `"Dockerfile"` | Path to the Dockerfile. | -| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. | -| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | -| image-namespace | string | false | | Namespace of Docker image. | -| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | -| ref | string | false | | Ref name to checkout | -| retention-days | number | false | `1` | Number of days the image artifact should be stored on GitHub. | -| working-directory | string | false | `"."` | Working directory for your Docker artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------- | ------ | -------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | +| docker-context | string | false | `"."` | The docker context. | +| docker-registry | string | false | | Host where the image should be pushed to. | +| dockerfile-path | string | false | `"Dockerfile"` | Path to the Dockerfile. | +| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. | +| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. | +| image-namespace | string | false | | Namespace of Docker image. | +| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. | +| ref | string | false | | Ref name to checkout | +| retention-days | number | false | `1` | Number of days the image artifact should be stored on GitHub. | +| working-directory | string | false | `"."` | Working directory for your Docker artifacts. (Default is .) | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-----------------------------------------| -| docker-password | true | Password for the Docker registry login. | -| docker-user | true | Username for the Docker registry login. | -| github-token | false | GitHub token. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | --------------------------------------- | +| docker-password | true | Password for the Docker registry login. | +| docker-user | true | Username for the Docker registry login. | +| github-token | false | GitHub token. | diff --git a/docs/references/wokflows/helm-gke-deploy/Variables.md b/docs/references/wokflows/helm-gke-deploy/Variables.md index c6ef5c681..2a7d80cb4 100644 --- a/docs/references/wokflows/helm-gke-deploy/Variables.md +++ b/docs/references/wokflows/helm-gke-deploy/Variables.md @@ -1,38 +1,43 @@ # Refenrences helm-gke-deploy reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|-------------|-------------------------------------------------------------------------------------------------| -| chart | string | true | | Helm chart to deploy | -| chart-version | string | false | | Chart version | -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| helm-version | string | false | `"v3.8.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | -| namespace | string | true | | K8s namespace to deploy in | -| post-renderer | string | false | | File path as string for a Helm post renderer | -| release-name | string | true | | Helm release name | -| repository-name | string | false | | Helm repository name | -| repository-url | string | false | | Url of the repository | -| timeout | string | false | `"1200"` | Timeout for the Helm command in seconds | -| values-yaml | string | true | | File path as string for a single Helm value file or as json array for multiple Helm value files | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ----------- | ----------------------------------------------------------------------------------------------- | +| chart | string | true | | Helm chart to deploy | +| chart-version | string | false | | Chart version | +| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | +| helm-version | string | false | `"v3.8.1"` | Helm version | +| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | +| namespace | string | true | | K8s namespace to deploy in | +| post-renderer | string | false | | File path as string for a Helm post renderer | +| release-name | string | true | | Helm release name | +| repository-name | string | false | | Helm repository name | +| repository-url | string | false | | Url of the repository | +| timeout | string | false | `"1200"` | Timeout for the Helm command in seconds | +| values-yaml | string | true | | File path as string for a single Helm value file or as json array for multiple Helm value files | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|---------------------|----------|--------------------------------------------| -| gke-cluster | true | GKE cluster for authentication | -| gke-project | true | GKE project id for authentication | -| gke-region | true | GKE region for authentication | -| gke-service-account | true | GKE service account key for authentication | +| SECRET | REQUIRED | DESCRIPTION | +| ------------------- | -------- | ------------------------------------------ | +| gke-cluster | true | GKE cluster for authentication | +| gke-project | true | GKE project id for authentication | +| gke-region | true | GKE region for authentication | +| gke-service-account | true | GKE service account key for authentication | diff --git a/docs/references/wokflows/helm-gke-destroy/Variables.md b/docs/references/wokflows/helm-gke-destroy/Variables.md index efedbbcc4..5d01e3402 100644 --- a/docs/references/wokflows/helm-gke-destroy/Variables.md +++ b/docs/references/wokflows/helm-gke-destroy/Variables.md @@ -1,61 +1,36 @@ # Refenrences helm-gke-destroy reusable Workflow -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|-------------|-----------------------------| -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| helm-version | string | false | `"v3.8.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | -| namespace | string | true | | K8s namespace to destroy in | -| release-name | string | true | | Helm release name | - ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|-------------|-----------------------------| -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| helm-version | string | false | `"v3.8.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | -| namespace | string | true | | K8s namespace to destroy in | -| release-name | string | true | | Helm release name | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ----------- | --------------------------- | +| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | +| helm-version | string | false | `"v3.8.1"` | Helm version | +| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | +| namespace | string | true | | K8s namespace to destroy in | +| release-name | string | true | | Helm release name | -## Outputs - -No outputs. - ## Outputs -No outputs. - -## Secrets - +No outputs. -| SECRET | REQUIRED | DESCRIPTION | -|---------------------|----------|--------------------------------------------| -| gke-cluster | true | GKE cluster for authentication | -| gke-project | true | GKE project id for authentication | -| gke-region | true | GKE region for authentication | -| gke-service-account | true | GKE service account key for authentication | + - ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|---------------------|----------|--------------------------------------------| -| gke-cluster | true | GKE cluster for authentication | -| gke-project | true | GKE project id for authentication | -| gke-region | true | GKE region for authentication | -| gke-service-account | true | GKE service account key for authentication | +| SECRET | REQUIRED | DESCRIPTION | +| ------------------- | -------- | ------------------------------------------ | +| gke-cluster | true | GKE cluster for authentication | +| gke-project | true | GKE project id for authentication | +| gke-region | true | GKE region for authentication | +| gke-service-account | true | GKE service account key for authentication | diff --git a/docs/references/wokflows/helm-multi-release/Variables.md b/docs/references/wokflows/helm-multi-release/Variables.md index 6a4fe59fa..b9068d049 100644 --- a/docs/references/wokflows/helm-multi-release/Variables.md +++ b/docs/references/wokflows/helm-multi-release/Variables.md @@ -1,31 +1,36 @@ # Refenrences helm-multi-release reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|------------------|--------|----------|------------------------------|----------------------------------------------------------------------------------------------------------------------------| -| artifact-dir | string | false | `"artifacts"` | Directory next to `charts-path` for preparation of the GitHub pages artifact. | -| charts-path | string | true | | The directory containing the Helm chart(s). | -| gh-pages-branch | string | false | `"gh-pages"` | Name of branch containing the artifacts | -| helm-version | string | false | `"v3.10.1"` | The Helm version. | -| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (See https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | -| subdirs | string | true | | List of subdir to consider | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ---------------- | ------ | -------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| artifact-dir | string | false | `"artifacts"` | Directory next to `charts-path` for preparation of the GitHub pages artifact. | +| charts-path | string | true | | The directory containing the Helm chart(s). | +| gh-pages-branch | string | false | `"gh-pages"` | Name of branch containing the artifacts | +| helm-version | string | false | `"v3.10.1"` | The Helm version. | +| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (See https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | +| subdirs | string | true | | List of subdir to consider | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | ----------------------------------------------- | +| github-email | true | The GitHub email for committing the changes. | +| github-token | true | The GitHub token for committing the changes. | +| github-username | true | The GitHub username for committing the changes. | diff --git a/docs/references/wokflows/helm-release/Variables.md b/docs/references/wokflows/helm-release/Variables.md index c5dfc7d8d..892a16d4a 100644 --- a/docs/references/wokflows/helm-release/Variables.md +++ b/docs/references/wokflows/helm-release/Variables.md @@ -1,59 +1,29 @@ # Refenrences helm-release reusable Workflow -## Outputs - - - -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|------------------------------------------------------|--------------------------------------------------| -| old-version | `"${{ jobs.helm-release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | -| release-version | `"${{ jobs.helm-release.outputs.release-version }}"` | The bumped version. | - - -## Secrets - - -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | - - ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|------------------|---------|----------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| -| artifact-dir | string | false | `"artifact"` | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | -| charts-dir | string | false | `"."` | The directory containing the Helm chart and `.bumpversion.cfg` file. | -| helm-version | string | false | `"v3.10.1"` | The Helm version. | -| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (See https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | -| page-url | string | true | | URL to the GitHub pages website of the repository. | -| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to checkout the repository. | -| release-type | string | true | | Scope of the release (major, minor or patch). | -| skip-download | boolean | false | `false` | Skip downloading index.yaml and previous Chart versions from GitHub pages. (To be used during setup of this workflow) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ---------------- | ------- | -------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| artifact-dir | string | false | `"artifact"` | Directory inside `charts-dir` for preparation of the GitHub pages artifact. | +| charts-dir | string | false | `"."` | The directory containing the Helm chart and `.bumpversion.cfg` file. | +| helm-version | string | false | `"v3.10.1"` | The Helm version. | +| lint-config-path | string | false | `".github/lint-config.yaml"` | The path to the lint configuration file (See https://github.com/helm/chart-testing/blob/main/pkg/config/test_config.yaml). | +| page-url | string | true | | URL to the GitHub pages website of the repository. | +| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to checkout the repository. | +| release-type | string | true | | Scope of the release (major, minor or patch). | +| skip-download | boolean | false | `false` | Skip downloading index.yaml and previous Chart versions from GitHub pages. (To be used during setup of this workflow) | + ## Outputs -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|------------------------------------------------------|--------------------------------------------------| -| old-version | `"${{ jobs.helm-release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | -| release-version | `"${{ jobs.helm-release.outputs.release-version }}"` | The bumped version. | +| OUTPUT | VALUE | DESCRIPTION | +| --------------- | ---------------------------------------------------- | ------------------------------------------------ | +| old-version | `"${{ jobs.helm-release.outputs.old-version }}"` | The old version in your `.bumpversion.cfg` file. | +| release-version | `"${{ jobs.helm-release.outputs.release-version }}"` | The bumped version. | -## Secrets - - - -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | - - diff --git a/docs/references/wokflows/java-gradle-base/Variables.md b/docs/references/wokflows/java-gradle-base/Variables.md index 035f748df..36a110e35 100644 --- a/docs/references/wokflows/java-gradle-base/Variables.md +++ b/docs/references/wokflows/java-gradle-base/Variables.md @@ -1,33 +1,38 @@ # Refenrences java-gradle-base reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|---------|----------|---------------|-------------------------------------------------------------------------------------| -| download-lfs-files | boolean | false | `false` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | -| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------- | -------- | ------------- | ----------------------------------------------------------------------------------- | +| download-lfs-files | boolean | false | `false` | Whether the Git checkout action should resolve LFS files or not. (Default is false) | +| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-------------------------|----------|-----------------------------------------------------------------| -| signing-key-id | true | Key id for signing the Sonatype publication. | -| signing-password | true | Password for signing the Sonatype publication. | -| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | -| sonar-organization | true | Organization for Sonarcloud | -| sonar-token | true | Token for Sonarcloud. | +| SECRET | REQUIRED | DESCRIPTION | +| ----------------------- | -------- | --------------------------------------------------------------- | +| signing-key-id | true | Key id for signing the Sonatype publication. | +| signing-password | true | Password for signing the Sonatype publication. | +| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | true | Organization for Sonarcloud | +| sonar-token | true | Token for Sonarcloud. | diff --git a/docs/references/wokflows/java-gradle-docker/Variables.md b/docs/references/wokflows/java-gradle-docker/Variables.md index db2e6bda4..7830ec9c3 100644 --- a/docs/references/wokflows/java-gradle-docker/Variables.md +++ b/docs/references/wokflows/java-gradle-docker/Variables.md @@ -1,39 +1,44 @@ # Refenrences java-gradle-docker reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|---------------|-------------------------------------------------------------| -| docker-publisher | string | true | | Publisher to prefix Docker image. | -| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ------------- | ----------------------------------------------------------- | +| docker-publisher | string | true | | Publisher to prefix Docker image. | +| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-------------------------|----------|-----------------------------------------------------------------| -| docker-password | true | Password for publishing to Dockerhub. | -| docker-username | true | Username for publishing to Dockerhub. | -| github-token | true | GitHub token for requesting changes from API. | -| github-username | true | GitHub username for requesting changes from API. | -| ossrh-password | true | Password for signing into Sonatype repository. | -| ossrh-username | true | Username for signing into Sonatype repository. | -| signing-key-id | true | Key id for signing the Sonatype publication. | -| signing-password | true | Password for signing the Sonatype publication. | -| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | -| sonar-organization | true | Organization for Sonarcloud | -| sonar-token | true | Token for Sonarcloud. | +| SECRET | REQUIRED | DESCRIPTION | +| ----------------------- | -------- | --------------------------------------------------------------- | +| docker-password | true | Password for publishing to Dockerhub. | +| docker-username | true | Username for publishing to Dockerhub. | +| github-token | true | GitHub token for requesting changes from API. | +| github-username | true | GitHub username for requesting changes from API. | +| ossrh-password | true | Password for signing into Sonatype repository. | +| ossrh-username | true | Username for signing into Sonatype repository. | +| signing-key-id | true | Key id for signing the Sonatype publication. | +| signing-password | true | Password for signing the Sonatype publication. | +| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | true | Organization for Sonarcloud | +| sonar-token | true | Token for Sonarcloud. | diff --git a/docs/references/wokflows/java-gradle-library/Variables.md b/docs/references/wokflows/java-gradle-library/Variables.md index e69de29bb..615e5f6ad 100644 --- a/docs/references/wokflows/java-gradle-library/Variables.md +++ b/docs/references/wokflows/java-gradle-library/Variables.md @@ -0,0 +1,41 @@ +# Refenrences java-gradle-library reusable Workflow + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ------------- | ----------------------------------------------------------- | +| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + + + +## Outputs + + + +No outputs. + + + +## Secrets + + + +| SECRET | REQUIRED | DESCRIPTION | +| ----------------------- | -------- | --------------------------------------------------------------- | +| github-token | true | GitHub token for requesting changes from API. | +| github-username | true | GitHub username for requesting changes from API. | +| ossrh-password | true | Password for signing into Sonatype repository. | +| ossrh-username | true | Username for signing into Sonatype repository. | +| signing-key-id | true | Key id for signing the Sonatype publication. | +| signing-password | true | Password for signing the Sonatype publication. | +| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | true | Organization for Sonarcloud | +| sonar-token | true | Token for Sonarcloud. | + + diff --git a/docs/references/wokflows/java-gradle-plugin/Variables.md b/docs/references/wokflows/java-gradle-plugin/Variables.md index 437202e15..3335fa3be 100644 --- a/docs/references/wokflows/java-gradle-plugin/Variables.md +++ b/docs/references/wokflows/java-gradle-plugin/Variables.md @@ -1,38 +1,43 @@ # Refenrences java-gradle-plugin reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|---------------|-------------------------------------------------------------| -| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ------------- | ----------------------------------------------------------- | +| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-------------------------|----------|-----------------------------------------------------------------| -| github-token | true | GitHub token for requesting changes from API. | -| github-username | true | GitHub username for requesting changes from API. | -| gradle-publish-key | true | Key for publishing to Gradle Plugin Portal. | -| gradle-publish-secret | true | Secret for publishing to Gradle Plugin Portal. | -| ossrh-password | true | Password for signing into Sonatype repository. | -| ossrh-username | true | Username for signing into Sonatype repository. | -| signing-key-id | true | Key id for signing the Sonatype publication. | -| signing-password | true | Password for signing the Sonatype publication. | -| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | -| sonar-organization | true | Organization for Sonarcloud | -| sonar-token | true | Token for Sonarcloud. | +| SECRET | REQUIRED | DESCRIPTION | +| ----------------------- | -------- | --------------------------------------------------------------- | +| github-token | true | GitHub token for requesting changes from API. | +| github-username | true | GitHub username for requesting changes from API. | +| gradle-publish-key | true | Key for publishing to Gradle Plugin Portal. | +| gradle-publish-secret | true | Secret for publishing to Gradle Plugin Portal. | +| ossrh-password | true | Password for signing into Sonatype repository. | +| ossrh-username | true | Username for signing into Sonatype repository. | +| signing-key-id | true | Key id for signing the Sonatype publication. | +| signing-password | true | Password for signing the Sonatype publication. | +| signing-secret-key-ring | true | Key ring (base64 encoded) for signing the Sonatype publication. | +| sonar-organization | true | Organization for Sonarcloud | +| sonar-token | true | Token for Sonarcloud. | diff --git a/docs/references/wokflows/java-gradle-release/Variables.md b/docs/references/wokflows/java-gradle-release/Variables.md index f23a17fc2..44da38ce8 100644 --- a/docs/references/wokflows/java-gradle-release/Variables.md +++ b/docs/references/wokflows/java-gradle-release/Variables.md @@ -1,36 +1,39 @@ # Refenrences java-gradle-release reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|------------------|-------------------------------------------------------------| -| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | -| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | -| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | -| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | -| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | -| release-type | string | true | | Scope of the release (major, minor or patch). | -| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ---------------- | ----------------------------------------------------------- | +| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | +| gradle-cache | boolean | false | `true` | Whether Gradle caching is enabled or not. (Default is true) | +| gradle-version | string | false | `"wrapper"` | Gradle version to be installed. (Default is wrapper) | +| java-distribution | string | false | `"microsoft"` | Java distribution to be installed. (Default is microsoft) | +| java-version | string | false | `"11"` | Java version to be installed. (Default is 11) | +| release-type | string | true | | Scope of the release (major, minor or patch). | +| working-directory | string | false | `"."` | Working directory of your Gradle artifacts. (Default is .) | + ## Outputs -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|-------------------------------------------------|---------------------------------| +| OUTPUT | VALUE | DESCRIPTION | +| --------------- | ----------------------------------------------- | ------------------------------- | | release-version | `"${{ jobs.release.outputs.release-version }}"` | Bumped version of your project. | + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|---------------------------------------------| -| github-email | true | GitHub email for committing the changes. | -| github-token | true | GitHub token for committing the changes. | -| github-username | true | GitHub username for committing the changes. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | ------------------------------------------- | +| github-email | true | GitHub email for committing the changes. | +| github-token | true | GitHub token for committing the changes. | +| github-username | true | GitHub username for committing the changes. | diff --git a/docs/references/wokflows/kustomize-gke-deploy/Variables.md b/docs/references/wokflows/kustomize-gke-deploy/Variables.md index fee983097..14c1c2bf3 100644 --- a/docs/references/wokflows/kustomize-gke-deploy/Variables.md +++ b/docs/references/wokflows/kustomize-gke-deploy/Variables.md @@ -1,31 +1,36 @@ # Refenrences kustomize-gke-deploy reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|-------------|----------------------------------------------------| -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| helm-version | string | false | `"v3.8.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | -| kustomization-path | string | true | | Path to the root directory of the kustomization | -| timeout | string | false | `"60"` | Time out(in seconds) for CustomResourceDefinitions | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ----------- | -------------------------------------------------- | +| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | +| helm-version | string | false | `"v3.8.1"` | Helm version | +| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | +| kustomization-path | string | true | | Path to the root directory of the kustomization | +| timeout | string | false | `"60"` | Time out(in seconds) for CustomResourceDefinitions | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|---------------------|----------|--------------------------------------------| -| gke-cluster | true | GKE cluster for authentication | -| gke-project | true | GKE project id for authentication | -| gke-region | true | GKE region for authentication | -| gke-service-account | true | GKE service account key for authentication | +| SECRET | REQUIRED | DESCRIPTION | +| ------------------- | -------- | ------------------------------------------ | +| gke-cluster | true | GKE cluster for authentication | +| gke-project | true | GKE project id for authentication | +| gke-region | true | GKE region for authentication | +| gke-service-account | true | GKE service account key for authentication | diff --git a/docs/references/wokflows/kustomize-gke-destroy/Variables.md b/docs/references/wokflows/kustomize-gke-destroy/Variables.md index 3a091a73b..12ba19053 100644 --- a/docs/references/wokflows/kustomize-gke-destroy/Variables.md +++ b/docs/references/wokflows/kustomize-gke-destroy/Variables.md @@ -1,18 +1,35 @@ # Refenrences kustomize-gke-destroy reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|-------------|-------------------------------------------------| -| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | -| helm-version | string | false | `"v3.8.1"` | Helm version | -| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | -| kustomization-path | string | true | | Path to the root directory of the kustomization | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------ | ------ | -------- | ----------- | ----------------------------------------------- | +| gcloud-sdk-version | string | false | `"376.0.0"` | GCloud SDK version | +| helm-version | string | false | `"v3.8.1"` | Helm version | +| kubectl-version | string | false | `"v1.23.0"` | Kubectl version | +| kustomization-path | string | true | | Path to the root directory of the kustomization | + ## Outputs + No outputs. + + +## Secrets + + + +| SECRET | REQUIRED | DESCRIPTION | +| ------------------- | -------- | ------------------------------------------ | +| gke-cluster | true | GKE cluster for authentication | +| gke-project | true | GKE project id for authentication | +| gke-region | true | GKE region for authentication | +| gke-service-account | true | GKE service account key for authentication | + + diff --git a/docs/references/wokflows/python-poetry-publish-pypi/Variables.md b/docs/references/wokflows/python-poetry-publish-pypi/Variables.md index d7212c580..288b1231b 100644 --- a/docs/references/wokflows/python-poetry-publish-pypi/Variables.md +++ b/docs/references/wokflows/python-poetry-publish-pypi/Variables.md @@ -1,27 +1,32 @@ # Refenrences python-poetry-publish-pypi reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|-----------|----------------------------------------------------------------------------| -| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | -| publish-to-test | boolean | false | `true` | If set to false, the packages are published to PyPI. (Default is true) | -| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. (Default is 3.10) | -| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | --------- | -------------------------------------------------------------------------- | +| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | +| publish-to-test | boolean | false | `true` | If set to false, the packages are published to PyPI. (Default is true) | +| python-version | string | false | `"3.10"` | The Python version for the Poetry virtual environment. (Default is 3.10) | +| working-directory | string | false | `"./"` | The working directory of your Python packages. (Default is root directory) | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|------------|----------|-------------| -| pypi-token | true | PyPI token | +| SECRET | REQUIRED | DESCRIPTION | +| ---------- | -------- | ----------- | +| pypi-token | true | PyPI token | diff --git a/docs/references/wokflows/python-poetry-publish-snapshot/Variables.md b/docs/references/wokflows/python-poetry-publish-snapshot/Variables.md index 6d8a66bff..ca1cc8a85 100644 --- a/docs/references/wokflows/python-poetry-publish-snapshot/Variables.md +++ b/docs/references/wokflows/python-poetry-publish-snapshot/Variables.md @@ -1,31 +1,34 @@ # Refenrences python-poetry-publish-snapshot reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|--------|----------|-----------|---------------------------------------------------------------------------| -| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | -| python-version | string | false | `"3.10"` | The Python version for setting up Poetry. (Default is 3.10) | -| working-directory | string | false | `"./"` | The working directory of your Python package. (Default is root directory) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------ | -------- | --------- | ------------------------------------------------------------------------- | +| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | +| python-version | string | false | `"3.10"` | The Python version for setting up Poetry. (Default is 3.10) | +| working-directory | string | false | `"./"` | The working directory of your Python package. (Default is root directory) | + ## Outputs -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|----------------------------------------------------------|------------------------------------| -| old-version | `"${{ jobs.publish-snapshot.outputs.old-version }}"` | The old version of the package. | +| OUTPUT | VALUE | DESCRIPTION | +| --------------- | -------------------------------------------------------- | ---------------------------------- | +| old-version | `"${{ jobs.publish-snapshot.outputs.old-version }}"` | The old version of the package. | | release-version | `"${{ jobs.publish-snapshot.outputs.release-version }}"` | The bumped version of the package. | + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|------------|----------|----------------| -| pypi-token | true | TestPyPI token | +| SECRET | REQUIRED | DESCRIPTION | +| ---------- | -------- | -------------- | +| pypi-token | true | TestPyPI token | diff --git a/docs/references/wokflows/python-poetry-release/Variables.md b/docs/references/wokflows/python-poetry-release/Variables.md index b37eb5aee..767292fce 100644 --- a/docs/references/wokflows/python-poetry-release/Variables.md +++ b/docs/references/wokflows/python-poetry-release/Variables.md @@ -1,37 +1,40 @@ # Refenrences python-poetry-release reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------|---------|----------|---------------------------------------------------|---------------------------------------------------------------------------| -| changelog | boolean | false | `true` | Create changelog for release. | -| changelog-config | string | false | | Changelog config path. | -| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | -| python-version | string | false | `"3.10"` | The Python version for setting up Poetry. (Default is 3.10) | -| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to checkout the repository. | -| release-type | string | true | | Scope of the release; See: https://python-poetry.org/docs/cli/#version | -| working-directory | string | false | `"./"` | The working directory of your Python package. (Default is root directory) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| changelog | boolean | false | `true` | Create changelog for release. | +| changelog-config | string | false | | Changelog config path. | +| poetry-version | string | false | `"1.5.1"` | The Poetry version to be installed. (Default is 1.5.1) | +| python-version | string | false | `"3.10"` | The Python version for setting up Poetry. (Default is 3.10) | +| ref | string | false | `"${{ github.event.repository.default_branch }}"` | The ref name to checkout the repository. | +| release-type | string | true | | Scope of the release; See: https://python-poetry.org/docs/cli/#version | +| working-directory | string | false | `"./"` | The working directory of your Python package. (Default is root directory) | + ## Outputs -| OUTPUT | VALUE | DESCRIPTION | -|-----------------|--------------------------------------------------------|------------------------------------| -| old-version | `"${{ jobs.create-release.outputs.old-version }}"` | The old version of the package. | +| OUTPUT | VALUE | DESCRIPTION | +| --------------- | ------------------------------------------------------ | ---------------------------------- | +| old-version | `"${{ jobs.create-release.outputs.old-version }}"` | The old version of the package. | | release-version | `"${{ jobs.create-release.outputs.release-version }}"` | The bumped version of the package. | + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | ----------------------------------------------- | +| github-email | true | The GitHub email for committing the changes. | +| github-token | true | The GitHub token for committing the changes. | +| github-username | true | The GitHub username for committing the changes. | diff --git a/docs/references/wokflows/release-tag-versions/Variables.md b/docs/references/wokflows/release-tag-versions/Variables.md index 784786756..e5487d43a 100644 --- a/docs/references/wokflows/release-tag-versions/Variables.md +++ b/docs/references/wokflows/release-tag-versions/Variables.md @@ -1,29 +1,34 @@ # Refenrences release-tag-versions reusable Workflow + ## Inputs -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-------------------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------| -| next-dev-release-suffix | string | false | `"SNAPSHOT"` | The suffix to add for the developer version | -| next-dev-release-type | string | true | | Scope of the next release (minor or patch) for developers | -| release-type | string | true | | Scope of the release (major, minor or patch). | -| version-configs-dir | string | true | | The Path to the directory containing the file where the versioning is defined and `.bumpversion.cfg` file. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------- | ------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------- | +| next-dev-release-suffix | string | false | `"SNAPSHOT"` | The suffix to add for the developer version | +| next-dev-release-type | string | true | | Scope of the next release (minor or patch) for developers | +| release-type | string | true | | Scope of the release (major, minor or patch). | +| version-configs-dir | string | true | | The Path to the directory containing the file where the versioning is defined and `.bumpversion.cfg` file. | + ## Outputs + No outputs. + + ## Secrets -| SECRET | REQUIRED | DESCRIPTION | -|-----------------|----------|-------------------------------------------------| -| github-email | true | The GitHub email for committing the changes. | -| github-token | true | The GitHub token for committing the changes. | -| github-username | true | The GitHub username for committing the changes. | +| SECRET | REQUIRED | DESCRIPTION | +| --------------- | -------- | ----------------------------------------------- | +| github-email | true | The GitHub email for committing the changes. | +| github-token | true | The GitHub token for committing the changes. | +| github-username | true | The GitHub username for committing the changes. | diff --git a/docs/references/wokflows/test-python-setup-poetry/Variables.md b/docs/references/wokflows/test-python-setup-poetry/Variables.md index 498463ef3..d877a0c81 100644 --- a/docs/references/wokflows/test-python-setup-poetry/Variables.md +++ b/docs/references/wokflows/test-python-setup-poetry/Variables.md @@ -1,16 +1,25 @@ # Refenrences test-python-setup-poetry reusable Workflow + ## Inputs + No inputs. + + ## Outputs + No outputs. + + ## Secrets + No secrets. +