From 259718da763337c34f990df0dfd36ebfb8e03046 Mon Sep 17 00:00:00 2001 From: MichaelKora Date: Wed, 29 Nov 2023 10:49:06 +0100 Subject: [PATCH] Test reformating --- .pre-commit-config.yaml | 1 + .../actions/action-lint/Variables.md | 38 ---------------- .../actions/bump-version/Variables.md | 24 ++++++++++ .../actions/changelog-generate/Variables.md | 29 ++++++++++++ docs/references/actions/checkout/Variables.md | 10 ----- .../actions/commit-and-push/Variables.md | 25 +++++++++++ .../actions/docker-push/Variables.md | 44 ------------------- .../references/actions/helm-lint/Variables.md | 21 +++++++++ .../Variables.md | 4 -- .../java-gradle-publish-plugin/Variables.md | 27 ++++++++++++ .../actions/java-gradle-release/Variables.md | 4 -- .../bump-version-release/Variables.md | 23 ++++++++++ 12 files changed, 150 insertions(+), 100 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e36f7384d..ec5f91ac5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,4 +1,5 @@ repos: + - repo: local hooks: - id: auto-doc diff --git a/docs/references/actions/action-lint/Variables.md b/docs/references/actions/action-lint/Variables.md index 1f03c1d9b..4e104e075 100644 --- a/docs/references/actions/action-lint/Variables.md +++ b/docs/references/actions/action-lint/Variables.md @@ -11,44 +11,6 @@ -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ------------------- | ------ | -------- | ----------- | ------------------------------------------ | -| action-lint-version | string | false | `"v1.6.22"` | The action lint repository version to use. | -| ref | string | false | | The ref name to checkout the repository. | - - - -## Outputs - - - -No outputs. - - - -## Inputs - - - -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ------------------- | ------ | -------- | ----------- | ------------------------------------------ | -| action-lint-version | string | false | `"v1.6.22"` | The action lint repository version to use. | -| ref | string | false | | The ref name to checkout the repository. | - - - -## Outputs - - - -No outputs. - - - ## Outputs 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/changelog-generate/Variables.md b/docs/references/actions/changelog-generate/Variables.md index e69de29bb..b1ee1d19e 100644 --- a/docs/references/actions/changelog-generate/Variables.md +++ b/docs/references/actions/changelog-generate/Variables.md @@ -0,0 +1,29 @@ +# Refenrences changelog-generate composite action + +## Inputs + + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ------------------------- | ------ | -------- | ---------------- | -------------------------------------------------------------- | +| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | +| commit-mode | string | false | `"false"` | Special configuration for projects which work without PRs. | +| config | string | false | | Path to the changelog config JSON file | +| fetch-release-information | string | false | `"false"` | Will enable fetching additional release information from tags. | +| fetch-reviewers | string | false | `"false"` | Will enable fetching the users/reviewers who approved the PR | +| github-token | string | true | | The GitHub token for committing the changes. | +| new-tag | string | true | | Version after bump | +| old-tag | string | false | | Previous version. Let empty for releases | + + + +## Outputs + + + +| OUTPUT | TYPE | DESCRIPTION | +| ---------------- | ------ | ----------------------------------------------------- | +| merged-changelog | string | Changelog containing listing of all single changelogs | +| single-changelog | string | Changelog containing changes of the latest tag | + + diff --git a/docs/references/actions/checkout/Variables.md b/docs/references/actions/checkout/Variables.md index a2ea3cefa..af603ff36 100644 --- a/docs/references/actions/checkout/Variables.md +++ b/docs/references/actions/checkout/Variables.md @@ -1,15 +1,5 @@ # Refenrences checkout composite action -## Outputs - - - -| OUTPUT | TYPE | DESCRIPTION | -| ------------- | ------ | ---------------------------------------------------------------- | -| lfs-cache-hit | string | A boolean value to indicate an exact match was found for the key | - - - ## Inputs diff --git a/docs/references/actions/commit-and-push/Variables.md b/docs/references/actions/commit-and-push/Variables.md index e69de29bb..5495cb245 100644 --- a/docs/references/actions/commit-and-push/Variables.md +++ b/docs/references/actions/commit-and-push/Variables.md @@ -0,0 +1,25 @@ +# 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-push/Variables.md b/docs/references/actions/docker-push/Variables.md index 3cbfb6563..821f6773e 100644 --- a/docs/references/actions/docker-push/Variables.md +++ b/docs/references/actions/docker-push/Variables.md @@ -14,50 +14,6 @@ -## 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. - - - -## Outputs - - - -No outputs. - - - -## 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 diff --git a/docs/references/actions/helm-lint/Variables.md b/docs/references/actions/helm-lint/Variables.md index e69de29bb..bfaf4ab5b 100644 --- a/docs/references/actions/helm-lint/Variables.md +++ b/docs/references/actions/helm-lint/Variables.md @@ -0,0 +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. | + + + +## 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 f3fa9658a..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,7 +27,3 @@ No outputs. - -## Inputs - -## Outputs diff --git a/docs/references/actions/java-gradle-publish-plugin/Variables.md b/docs/references/actions/java-gradle-publish-plugin/Variables.md index 85a4fb249..a486fe8c9 100644 --- a/docs/references/actions/java-gradle-publish-plugin/Variables.md +++ b/docs/references/actions/java-gradle-publish-plugin/Variables.md @@ -1 +1,28 @@ # 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-release/Variables.md b/docs/references/actions/java-gradle-release/Variables.md index 40d88e685..2fc42d848 100644 --- a/docs/references/actions/java-gradle-release/Variables.md +++ b/docs/references/actions/java-gradle-release/Variables.md @@ -28,7 +28,3 @@ | release-version | string | The bumped version of your release. | - -## Inputs - -## Outputs diff --git a/docs/references/wokflows/bump-version-release/Variables.md b/docs/references/wokflows/bump-version-release/Variables.md index 79eaf4b04..b1637929d 100644 --- a/docs/references/wokflows/bump-version-release/Variables.md +++ b/docs/references/wokflows/bump-version-release/Variables.md @@ -12,3 +12,26 @@ | 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. | + +