Skip to content

Commit

Permalink
Check precommit after runing them loclally
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKora committed Nov 29, 2023
1 parent 089a560 commit 084ad79
Show file tree
Hide file tree
Showing 48 changed files with 691 additions and 616 deletions.
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ repos:
language: script
name: Generate doc
entry: ./generate-doc.sh
types: [file]

# stages:
# - "manual"

Expand Down
8 changes: 8 additions & 0 deletions docs/references/actions/action-lint/Variables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# 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
29 changes: 29 additions & 0 deletions docs/references/actions/changelog-generate/Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Refenrences changelog-generate composite action

## Inputs

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

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

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

## Outputs

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

| OUTPUT | TYPE | DESCRIPTION |
| ---------------- | ------ | ----------------------------------------------------- |
| merged-changelog | string | Changelog containing listing of all single changelogs |
| single-changelog | string | Changelog containing changes of the latest tag |

<!-- AUTO-DOC-OUTPUT:END -->
26 changes: 0 additions & 26 deletions docs/references/actions/checkout/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,6 @@

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

## Inputs

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

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

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

## Outputs

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

| OUTPUT | TYPE | DESCRIPTION |
| ------------- | ------ | ---------------------------------------------------------------- |
| lfs-cache-hit | string | A boolean value to indicate an exact match was found for the key |

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

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
Expand Down
48 changes: 0 additions & 48 deletions docs/references/actions/commit-and-push/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,54 +16,6 @@

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

## Inputs

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

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

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

## Inputs

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

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

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

## Outputs

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

## Inputs

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ------------------- | ------ | -------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
| docker-registry | string | false | | Host where the image should be pushed to. |
| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. |
| working-directory | string | false | `"."` | Working directory for your Docker artifacts. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---------------------|--------|----------|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| docker-registry | string | false | | Host where the image should be pushed to. |
| image-artifact-name | string | false | `"image-artifact"` | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. |
| working-directory | string | false | `"."` | Working directory for your Docker artifacts. |

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

## Outputs

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

No outputs.

<!-- AUTO-DOC-OUTPUT:END -->
40 changes: 7 additions & 33 deletions docs/references/actions/docker-push/Variables.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,19 @@
# Refenrences docker-push composite action

## Inputs

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

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

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

## Inputs

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------- | ------ | -------- | ------------------------------------------------------ | -------------------------------------------- |
| docker-registry | string | false | | Host where the image should be pushed to. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. |
| working-directory | string | false | `"."` | Working directory for your Docker artifacts. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------|--------|----------|--------------------------------------------------------|----------------------------------------------|
| docker-registry | string | false | | Host where the image should be pushed to. |
| image-name | string | false | `"${{ github.event.repository.name }}"` | Name of Docker image. |
| image-namespace | string | false | | Namespace of Docker image. |
| image-tag | string | false | `"pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8}"` | Tag of Docker image. |
| working-directory | string | false | `"."` | Working directory for your Docker artifacts. |

<!-- 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 -->
28 changes: 0 additions & 28 deletions docs/references/actions/helm-deploy/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,6 @@

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

## Inputs

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

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

<!-- 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 -->
Expand Down
20 changes: 0 additions & 20 deletions docs/references/actions/helm-destroy/Variables.md
Original file line number Diff line number Diff line change
@@ -1,20 +0,0 @@
# 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 -->
Loading

0 comments on commit 084ad79

Please sign in to comment.