Skip to content

Commit

Permalink
Check precommit after runing them loclally 2
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKora committed Nov 29, 2023
1 parent 084ad79 commit 0a5b122
Show file tree
Hide file tree
Showing 18 changed files with 136 additions and 363 deletions.
39 changes: 20 additions & 19 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -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"
8 changes: 0 additions & 8 deletions docs/references/actions/action-lint/Variables.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Refenrences action-lint composite action

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
Expand Down
24 changes: 24 additions & 0 deletions docs/references/actions/bump-version/Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Refenrences bump-version composite action

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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. |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
| --------------- | ------ | ------------------------------------------------ |
| old-version | string | The old version in your `.bumpversion.cfg` file. |
| release-version | string | The bumped version of your project. |

<!-- AUTO-DOC-OUTPUT:END -->
20 changes: 20 additions & 0 deletions docs/references/actions/helm-destroy/Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Refenrences helm-destroy composite action

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------ | ------ | -------- | ------- | --------------------------- |
| namespace | string | true | | K8s namespace to destroy in |
| release-name | string | true | | Helm release name |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
40 changes: 6 additions & 34 deletions docs/references/actions/helm-lint/Variables.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,21 @@
# Refenrences helm-lint composite action
## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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. |

<!-- AUTO-DOC-INPUT:END -->
## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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. |

<!-- AUTO-DOC-INPUT:END -->
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.
<!-- AUTO-DOC-OUTPUT:END -->
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.
<!-- AUTO-DOC-OUTPUT:END -->
## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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. |

<!-- AUTO-DOC-INPUT:END -->
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
8 changes: 0 additions & 8 deletions docs/references/actions/helm-package/Variables.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Refenrences helm-package composite action

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
Expand Down
26 changes: 5 additions & 21 deletions docs/references/actions/helm-setup/Variables.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,20 @@
# Refenrences helm-setup composite action
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.
<!-- AUTO-DOC-OUTPUT:END -->
## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 |

<!-- AUTO-DOC-INPUT:END -->
## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------|--------|----------|-------------|-----------------|
| helm-version | string | false | `"v3.10.1"` | Helm version |
| kubectl-version | string | false | `"v1.23.0"` | Kubectl version |

<!-- AUTO-DOC-INPUT:END -->
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.
<!-- AUTO-DOC-OUTPUT:END -->
## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,3 @@
No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
27 changes: 0 additions & 27 deletions docs/references/actions/java-gradle-publish-plugin/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,3 @@
No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
54 changes: 0 additions & 54 deletions docs/references/actions/java-gradle-publish/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,60 +19,6 @@

<!-- AUTO-DOC-INPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
Expand Down
24 changes: 24 additions & 0 deletions docs/references/actions/java-gradle-test/Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Refenrences java-gradle-test composite action

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
Loading

0 comments on commit 0a5b122

Please sign in to comment.