diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a9e04abf2..34b6d6363 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,22 +1,23 @@ ---- repos: - - repo: local - hooks: - - id: auto-doc - language: script - name: Generate doc - entry: ./generate-doc.sh - types: [file] - # stages: - # - "manual" +- repo: local + hooks: - - repo: https://github.com/executablebooks/mdformat - rev: 0.7.17 - hooks: - - id: mdformat - additional_dependencies: - - mdformat-gfm - - mdformat-black - # stages: - # - "manual" + - id: auto-doc + language: script + name: Generate doc + entry: ./generate-doc.sh + types: [file] + # 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/docs/references/actions/action-lint/Variables.md b/docs/references/actions/action-lint/Variables.md index d8b302165..4e104e075 100644 --- a/docs/references/actions/action-lint/Variables.md +++ b/docs/references/actions/action-lint/Variables.md @@ -1,13 +1,5 @@ # Refenrences action-lint composite action -## Outputs - - - -No outputs. - - - ## Inputs diff --git a/docs/references/actions/bump-version/Variables.md b/docs/references/actions/bump-version/Variables.md index e69de29bb..81f7d92e4 100644 --- a/docs/references/actions/bump-version/Variables.md +++ b/docs/references/actions/bump-version/Variables.md @@ -0,0 +1,24 @@ +# 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/helm-destroy/Variables.md b/docs/references/actions/helm-destroy/Variables.md index e69de29bb..fcbdf804b 100644 --- a/docs/references/actions/helm-destroy/Variables.md +++ b/docs/references/actions/helm-destroy/Variables.md @@ -0,0 +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 | + + + +## Outputs + + + +No outputs. + + diff --git a/docs/references/actions/helm-lint/Variables.md b/docs/references/actions/helm-lint/Variables.md index bcaf5e318..bfaf4ab5b 100644 --- a/docs/references/actions/helm-lint/Variables.md +++ b/docs/references/actions/helm-lint/Variables.md @@ -1,49 +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. | - - ## 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. - ## Outputs -No outputs. - -## 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 index cd0409347..b981b49e2 100644 --- a/docs/references/actions/helm-package/Variables.md +++ b/docs/references/actions/helm-package/Variables.md @@ -1,13 +1,5 @@ # Refenrences helm-package composite action -## Outputs - - - -No outputs. - - - ## Inputs diff --git a/docs/references/actions/helm-setup/Variables.md b/docs/references/actions/helm-setup/Variables.md index b15c38b4b..2bc2ccc97 100644 --- a/docs/references/actions/helm-setup/Variables.md +++ b/docs/references/actions/helm-setup/Variables.md @@ -1,36 +1,20 @@ # Refenrences helm-setup composite action -## Outputs - -No outputs. - ## 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 | -## 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. - -## 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 f8cbe65fd..7450350f0 100644 --- a/docs/references/actions/java-gradle-assess-code-quality/Variables.md +++ b/docs/references/actions/java-gradle-assess-code-quality/Variables.md @@ -27,31 +27,3 @@ No outputs. - -## 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-publish-plugin/Variables.md b/docs/references/actions/java-gradle-publish-plugin/Variables.md index 2fbfe6b7c..a486fe8c9 100644 --- a/docs/references/actions/java-gradle-publish-plugin/Variables.md +++ b/docs/references/actions/java-gradle-publish-plugin/Variables.md @@ -26,30 +26,3 @@ 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 1344e3a40..b968ffa52 100644 --- a/docs/references/actions/java-gradle-publish/Variables.md +++ b/docs/references/actions/java-gradle-publish/Variables.md @@ -19,60 +19,6 @@ -## 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. - - - -## 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-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 diff --git a/docs/references/actions/java-gradle-test/Variables.md b/docs/references/actions/java-gradle-test/Variables.md index e69de29bb..25a05abfa 100644 --- a/docs/references/actions/java-gradle-test/Variables.md +++ b/docs/references/actions/java-gradle-test/Variables.md @@ -0,0 +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 .) | + + + +## Outputs + + + +No outputs. + + diff --git a/docs/references/actions/java-maven-release/Variables.md b/docs/references/actions/java-maven-release/Variables.md index 171a833fd..bfdfc4165 100644 --- a/docs/references/actions/java-maven-release/Variables.md +++ b/docs/references/actions/java-maven-release/Variables.md @@ -1,51 +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 .) | +| 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/kustomize-destroy/Variables.md b/docs/references/actions/kustomize-destroy/Variables.md index 1112b8065..948c33a3c 100644 --- a/docs/references/actions/kustomize-destroy/Variables.md +++ b/docs/references/actions/kustomize-destroy/Variables.md @@ -10,24 +10,6 @@ -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ------------------ | ------ | -------- | ------- | ----------------------------------------------- | -| kustomization-path | string | true | | Path to the root directory of the kustomization | - - - -## Outputs - - - -No outputs. - - - ## Outputs diff --git a/docs/references/actions/python-poetry-bump-version/Variables.md b/docs/references/actions/python-poetry-bump-version/Variables.md index 4cbe43c4e..8dfb7e55c 100644 --- a/docs/references/actions/python-poetry-bump-version/Variables.md +++ b/docs/references/actions/python-poetry-bump-version/Variables.md @@ -1,45 +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. | - - ## 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. | -| release-version | string | The bumped version of your package. | - - ## 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 26b9d98e8..4acd66b40 100644 --- a/docs/references/actions/python-poetry-publish-pypi/Variables.md +++ b/docs/references/actions/python-poetry-publish-pypi/Variables.md @@ -1,33 +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) | - - ## 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. - ## Outputs + No outputs. + diff --git a/docs/references/actions/python-poetry-publish/Variables.md b/docs/references/actions/python-poetry-publish/Variables.md index 7ca99ee2e..1b30503be 100644 --- a/docs/references/actions/python-poetry-publish/Variables.md +++ b/docs/references/actions/python-poetry-publish/Variables.md @@ -1,37 +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) | - - ## 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. - ## Outputs + No outputs. + diff --git a/docs/references/wokflows/helm-release/Variables.md b/docs/references/wokflows/helm-release/Variables.md index 103804bbf..a55bf1b27 100644 --- a/docs/references/wokflows/helm-release/Variables.md +++ b/docs/references/wokflows/helm-release/Variables.md @@ -1,17 +1,5 @@ # Refenrences helm-release reusable Workflow -## 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 diff --git a/docs/references/wokflows/java-gradle-plugin/Variables.md b/docs/references/wokflows/java-gradle-plugin/Variables.md index a115f3080..3335fa3be 100644 --- a/docs/references/wokflows/java-gradle-plugin/Variables.md +++ b/docs/references/wokflows/java-gradle-plugin/Variables.md @@ -1,13 +1,5 @@ # Refenrences java-gradle-plugin reusable Workflow -## Outputs - - - -No outputs. - - - ## Inputs @@ -22,26 +14,6 @@ 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. | - - - ## Outputs