diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fbe07fe94..d62cd764a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,7 @@ default_language_version: python: python3.11.4 # exclude: ".*tmps.*" -fail_fast: true +# fail_fast: true repos: - repo: local @@ -15,12 +15,6 @@ repos: - "python" - "file" - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.0.1 - hooks: - - id: check-yaml - - id: trailing-whitespace - - repo: https://github.com/executablebooks/mdformat rev: 0.7.17 hooks: @@ -29,10 +23,17 @@ repos: - mdformat-gfm - mdformat-black # files: '.*Variables\.md$' - dir: docs/ + # dir: docs/ files: '.*\.md$' exclude: '.*Readme\.md$' + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.0.1 + hooks: + - id: check-yaml + - id: trailing-whitespace + + # - repo: https://github.com/markdownlint/markdownlint # rev: v0.13.0 # hooks: diff --git a/docs/references/actions/action-lint/Variables.md b/docs/references/actions/action-lint/Variables.md deleted file mode 100644 index 22ed166e2..000000000 --- a/docs/references/actions/action-lint/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# 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. | -| reff | 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 deleted file mode 100644 index 6a7804caa..000000000 --- a/docs/references/actions/bump-version/Variables.md +++ /dev/null @@ -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 deleted file mode 100644 index 29bfd8900..000000000 --- a/docs/references/actions/changelog-generate/Variables.md +++ /dev/null @@ -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 deleted file mode 100644 index 725aae547..000000000 --- a/docs/references/actions/checkout/Variables.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 | - - -## Outputs - - - -| 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 deleted file mode 100644 index 3e0ba0f2b..000000000 --- a/docs/references/actions/commit-and-push/Variables.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/docker-build/Variables.md b/docs/references/actions/docker-build/Variables.md deleted file mode 100644 index e0f8ab24d..000000000 --- a/docs/references/actions/docker-build/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/docker-publish/Variables.md b/docs/references/actions/docker-publish/Variables.md deleted file mode 100644 index 8fbdff4dd..000000000 --- a/docs/references/actions/docker-publish/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/docker-push/Variables.md b/docs/references/actions/docker-push/Variables.md deleted file mode 100644 index 124fea84e..000000000 --- a/docs/references/actions/docker-push/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/helm-deploy/Variables.md b/docs/references/actions/helm-deploy/Variables.md deleted file mode 100644 index 8353ca16e..000000000 --- a/docs/references/actions/helm-deploy/Variables.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/helm-destroy/Variables.md b/docs/references/actions/helm-destroy/Variables.md deleted file mode 100644 index 72d8d22fa..000000000 --- a/docs/references/actions/helm-destroy/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# 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 | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/helm-lint/Variables.md b/docs/references/actions/helm-lint/Variables.md deleted file mode 100644 index 692ece49c..000000000 --- a/docs/references/actions/helm-lint/Variables.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/helm-package/Variables.md b/docs/references/actions/helm-package/Variables.md deleted file mode 100644 index 39d6f3681..000000000 --- a/docs/references/actions/helm-package/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/helm-setup/Variables.md b/docs/references/actions/helm-setup/Variables.md deleted file mode 100644 index cfccaa5bd..000000000 --- a/docs/references/actions/helm-setup/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# 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 | - - -## 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 deleted file mode 100644 index 5fcbbaa36..000000000 --- a/docs/references/actions/java-gradle-assess-code-quality/Variables.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-build-jib/Variables.md b/docs/references/actions/java-gradle-build-jib/Variables.md deleted file mode 100644 index c25106680..000000000 --- a/docs/references/actions/java-gradle-build-jib/Variables.md +++ /dev/null @@ -1,24 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-build/Variables.md b/docs/references/actions/java-gradle-build/Variables.md deleted file mode 100644 index 0bc2aaee6..000000000 --- a/docs/references/actions/java-gradle-build/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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 .) | - - -## 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 deleted file mode 100644 index 82d3a8694..000000000 --- a/docs/references/actions/java-gradle-publish-plugin/Variables.md +++ /dev/null @@ -1,24 +0,0 @@ -# Refenrences java-gradle-publish-plugin composite action -## 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 deleted file mode 100644 index b7adc3d28..000000000 --- a/docs/references/actions/java-gradle-publish/Variables.md +++ /dev/null @@ -1,24 +0,0 @@ -# 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 deleted file mode 100644 index 583f0d349..000000000 --- a/docs/references/actions/java-gradle-release-github/Variables.md +++ /dev/null @@ -1,22 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-release/Variables.md b/docs/references/actions/java-gradle-release/Variables.md deleted file mode 100644 index f8ecb231c..000000000 --- a/docs/references/actions/java-gradle-release/Variables.md +++ /dev/null @@ -1,28 +0,0 @@ -# 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 .) | - - -## Outputs - - - -| 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 deleted file mode 100644 index a8c8778a0..000000000 --- a/docs/references/actions/java-gradle-setup/Variables.md +++ /dev/null @@ -1,18 +0,0 @@ -# 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) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-gradle-test/Variables.md b/docs/references/actions/java-gradle-test/Variables.md deleted file mode 100644 index 7b278e39e..000000000 --- a/docs/references/actions/java-gradle-test/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-maven-build/Variables.md b/docs/references/actions/java-maven-build/Variables.md deleted file mode 100644 index e5a39395e..000000000 --- a/docs/references/actions/java-maven-build/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/java-maven-release/Variables.md b/docs/references/actions/java-maven-release/Variables.md deleted file mode 100644 index 68450c2f6..000000000 --- a/docs/references/actions/java-maven-release/Variables.md +++ /dev/null @@ -1,26 +0,0 @@ -# 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 .) | - - -## Outputs - - - -| 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 deleted file mode 100644 index a66c8efc3..000000000 --- a/docs/references/actions/java-maven-setup/Variables.md +++ /dev/null @@ -1,17 +0,0 @@ -# Refenrences java-maven-setup composite action -## 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 deleted file mode 100644 index bc436fa31..000000000 --- a/docs/references/actions/java-maven-test/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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 .) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/kustomize-deploy/Variables.md b/docs/references/actions/kustomize-deploy/Variables.md deleted file mode 100644 index 93b90b052..000000000 --- a/docs/references/actions/kustomize-deploy/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# 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 | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/kustomize-destroy/Variables.md b/docs/references/actions/kustomize-destroy/Variables.md deleted file mode 100644 index b7f16ba0f..000000000 --- a/docs/references/actions/kustomize-destroy/Variables.md +++ /dev/null @@ -1,15 +0,0 @@ -# Refenrences kustomize-destroy composite action -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|--------------------|--------|----------|---------|-------------------------------------------------| -| kustomization-path | string | true | | Path to the root directory of the kustomization | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/port-forward/Variables.md b/docs/references/actions/port-forward/Variables.md deleted file mode 100644 index e7c84682b..000000000 --- a/docs/references/actions/port-forward/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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 | - - -## 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 deleted file mode 100644 index b5335e2fd..000000000 --- a/docs/references/actions/python-poetry-bump-version/Variables.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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. | - - -## Outputs - - - -| 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 deleted file mode 100644 index f1b2a2446..000000000 --- a/docs/references/actions/python-poetry-publish-pypi/Variables.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/python-poetry-publish/Variables.md b/docs/references/actions/python-poetry-publish/Variables.md deleted file mode 100644 index 7b4ff8a6a..000000000 --- a/docs/references/actions/python-poetry-publish/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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) | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/python-setup-poetry/Variables.md b/docs/references/actions/python-setup-poetry/Variables.md deleted file mode 100644 index 4751c45f4..000000000 --- a/docs/references/actions/python-setup-poetry/Variables.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/setup-credentials/Variables.md b/docs/references/actions/setup-credentials/Variables.md deleted file mode 100644 index c74726136..000000000 --- a/docs/references/actions/setup-credentials/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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 | - - -## Outputs - - -No outputs. - diff --git a/docs/references/actions/substitute-envs/Variables.md b/docs/references/actions/substitute-envs/Variables.md deleted file mode 100644 index d339a4a21..000000000 --- a/docs/references/actions/substitute-envs/Variables.md +++ /dev/null @@ -1,19 +0,0 @@ -# Refenrences substitute-envs composite action -## Inputs - - - -| 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 | - - diff --git a/docs/references/actions/tag-and-release/Variables.md b/docs/references/actions/tag-and-release/Variables.md deleted file mode 100644 index 2d1a45d25..000000000 --- a/docs/references/actions/tag-and-release/Variables.md +++ /dev/null @@ -1,20 +0,0 @@ -# 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. | - - -## Outputs - - -No outputs. - diff --git a/docs/references/workflows/bump-version-release/Variables.md b/docs/references/workflows/bump-version-release/Variables.md deleted file mode 100644 index 5be9c44d2..000000000 --- a/docs/references/workflows/bump-version-release/Variables.md +++ /dev/null @@ -1,34 +0,0 @@ -# Refenrences bump-version-release reusable Workflow -## 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 .) | - - -## 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. | - - diff --git a/docs/references/workflows/docker-build-and-publish/Variables.md b/docs/references/workflows/docker-build-and-publish/Variables.md deleted file mode 100644 index a53c31136..000000000 --- a/docs/references/workflows/docker-build-and-publish/Variables.md +++ /dev/null @@ -1,35 +0,0 @@ -# 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 .) | - - -## 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. | - - diff --git a/docs/references/workflows/helm-gke-deploy/Variables.md b/docs/references/workflows/helm-gke-deploy/Variables.md deleted file mode 100644 index c6ef5c681..000000000 --- a/docs/references/workflows/helm-gke-deploy/Variables.md +++ /dev/null @@ -1,38 +0,0 @@ -# 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 | - - -## 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/workflows/helm-gke-destroy/Variables.md b/docs/references/workflows/helm-gke-destroy/Variables.md deleted file mode 100644 index 1fe1a4aae..000000000 --- a/docs/references/workflows/helm-gke-destroy/Variables.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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 | - - -## 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/workflows/helm-multi-release/Variables.md b/docs/references/workflows/helm-multi-release/Variables.md deleted file mode 100644 index 6a4fe59fa..000000000 --- a/docs/references/workflows/helm-multi-release/Variables.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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 | - - -## 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. | - - diff --git a/docs/references/workflows/helm-release/Variables.md b/docs/references/workflows/helm-release/Variables.md deleted file mode 100644 index a9d1962c5..000000000 --- a/docs/references/workflows/helm-release/Variables.md +++ /dev/null @@ -1,38 +0,0 @@ -# Refenrences helm-release reusable Workflow -## 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) | - - -## 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. | - - diff --git a/docs/references/workflows/java-gradle-base/Variables.md b/docs/references/workflows/java-gradle-base/Variables.md deleted file mode 100644 index 035f748df..000000000 --- a/docs/references/workflows/java-gradle-base/Variables.md +++ /dev/null @@ -1,33 +0,0 @@ -# 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 .) | - - -## 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. | - - diff --git a/docs/references/workflows/java-gradle-docker/Variables.md b/docs/references/workflows/java-gradle-docker/Variables.md deleted file mode 100644 index db2e6bda4..000000000 --- a/docs/references/workflows/java-gradle-docker/Variables.md +++ /dev/null @@ -1,39 +0,0 @@ -# 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 .) | - - -## 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. | - - diff --git a/docs/references/workflows/java-gradle-library/Variables.md b/docs/references/workflows/java-gradle-library/Variables.md deleted file mode 100644 index 2313ace58..000000000 --- a/docs/references/workflows/java-gradle-library/Variables.md +++ /dev/null @@ -1,36 +0,0 @@ -# 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/workflows/java-gradle-plugin/Variables.md b/docs/references/workflows/java-gradle-plugin/Variables.md deleted file mode 100644 index 437202e15..000000000 --- a/docs/references/workflows/java-gradle-plugin/Variables.md +++ /dev/null @@ -1,38 +0,0 @@ -# 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 .) | - - -## 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. | - - diff --git a/docs/references/workflows/java-gradle-release/Variables.md b/docs/references/workflows/java-gradle-release/Variables.md deleted file mode 100644 index f23a17fc2..000000000 --- a/docs/references/workflows/java-gradle-release/Variables.md +++ /dev/null @@ -1,36 +0,0 @@ -# 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 .) | - - -## Outputs - - - -| 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. | - - diff --git a/docs/references/workflows/kustomize-gke-deploy/Variables.md b/docs/references/workflows/kustomize-gke-deploy/Variables.md deleted file mode 100644 index fee983097..000000000 --- a/docs/references/workflows/kustomize-gke-deploy/Variables.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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 | - - -## 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/workflows/kustomize-gke-destroy/Variables.md b/docs/references/workflows/kustomize-gke-destroy/Variables.md deleted file mode 100644 index ac7b0e3da..000000000 --- a/docs/references/workflows/kustomize-gke-destroy/Variables.md +++ /dev/null @@ -1,30 +0,0 @@ -# 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 | - - -## 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/workflows/python-poetry-publish-pypi/Variables.md b/docs/references/workflows/python-poetry-publish-pypi/Variables.md deleted file mode 100644 index d7212c580..000000000 --- a/docs/references/workflows/python-poetry-publish-pypi/Variables.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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) | - - -## Outputs - - -No outputs. - -## Secrets - - - -| SECRET | REQUIRED | DESCRIPTION | -|------------|----------|-------------| -| pypi-token | true | PyPI token | - - diff --git a/docs/references/workflows/python-poetry-publish-snapshot/Variables.md b/docs/references/workflows/python-poetry-publish-snapshot/Variables.md deleted file mode 100644 index 6d8a66bff..000000000 --- a/docs/references/workflows/python-poetry-publish-snapshot/Variables.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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) | - - -## Outputs - - - -| 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 | - - diff --git a/docs/references/workflows/python-poetry-release/Variables.md b/docs/references/workflows/python-poetry-release/Variables.md deleted file mode 100644 index b37eb5aee..000000000 --- a/docs/references/workflows/python-poetry-release/Variables.md +++ /dev/null @@ -1,37 +0,0 @@ -# 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) | - - -## Outputs - - - -| 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. | - - diff --git a/docs/references/workflows/release-tag-versions/Variables.md b/docs/references/workflows/release-tag-versions/Variables.md deleted file mode 100644 index 784786756..000000000 --- a/docs/references/workflows/release-tag-versions/Variables.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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. | - - -## 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. | - - diff --git a/docs/references/workflows/test-python-setup-poetry/Variables.md b/docs/references/workflows/test-python-setup-poetry/Variables.md deleted file mode 100644 index 498463ef3..000000000 --- a/docs/references/workflows/test-python-setup-poetry/Variables.md +++ /dev/null @@ -1,16 +0,0 @@ -# Refenrences test-python-setup-poetry reusable Workflow -## Inputs - - -No inputs. - -## Outputs - - -No outputs. - -## Secrets - - -No secrets. - diff --git a/format_md_with_dprint.py b/format_md_with_dprint.py deleted file mode 100644 index 1a1301080..000000000 --- a/format_md_with_dprint.py +++ /dev/null @@ -1,18 +0,0 @@ -import subprocess -import sys -# import os - - -def format_md_with_dprint(files): - for file_path in files: - subprocess.run(['dprint', 'fmt', file_path], check=True) - - -if __name__ == "__main__": - # Get the list of files from pre-commit arguments - # files_to_format = sys.argv[1:] - - # Format Markdown files with dprint - format_md_with_dprint(files_to_format) - - sys.exit(0)