Skip to content

Commit

Permalink
Add mark down cleaner as overwrite
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelKora
MichaelKora committed Nov 27, 2023
1 parent 482d2ae commit 22a0ece
Show file tree
Hide file tree
Showing 92 changed files with 1,245 additions and 1,071 deletions.
304 changes: 152 additions & 152 deletions .github/workflows/README.md
View file

Large diffs are not rendered by default.

13 changes: 11 additions & 2 deletions .pre-commit-config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ repos:
language: script
name: Generate doc
entry: ./generate-doc.sh
stage: [manual]
# stage: [commit]
# stages:
# - "manual"

- repo: https://github.com/executablebooks/mdformat
rev: 0.7.17
hooks:
- id: mdformat
additional_dependencies:
- mdformat-gfm
- mdformat-black
# stages:
# - "manual"
4 changes: 2 additions & 2 deletions actions/action-lint/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This action will lint all actions and workflows of a repository.

| Name | Required | Default Value | Type | Description |
| ------------------- | :------: | :-----------: | :----: | ------------------------------------------ |
| ref | ❌ | "" | string | The ref name to checkout the repository. |
| action-lint-version | ❌ | v1.6.22 | string | The action lint repository version to use. |
| ref | ❌ | "" | string | The ref name to checkout the repository. |
| action-lint-version | ❌ | v1.6.22 | string | The action lint repository version to use. |

## Usage

Expand Down
6 changes: 3 additions & 3 deletions actions/bump-version/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ current_version = 0.0.1

| Name | Required | Default Value | Description |
| ----------------- | :------: | :-----------: | ----------------------------------------------------- |
| release-type | ✅ | - | The scope of the release (major, minor or patch) |
| working-directory | ❌ | . | The directory containing the `.bumpversion.cfg` file. |
| new-version | ❌ | . | New version to use for the bump |
| release-type | ✅ | - | The scope of the release (major, minor or patch) |
| working-directory | ❌ | . | The directory containing the `.bumpversion.cfg` file. |
| new-version | ❌ | . | New version to use for the bump |

### Outputs

Expand Down
16 changes: 8 additions & 8 deletions actions/changelog-generate/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@ Additional configuration options can be explored

| Name | Required | Default Value | Description |
| ------------------------- | :------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| github-token | ✅ | - | The GitHub token for committing the changes |
| new-tag | ✅ | - | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) |
| changelog-file | ❌ | "CHANGELOG.md" | Path to the Changelog.md file |
| commit-mode | ❌ | "false" | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. |
| config | ❌ | "" | Path to the changelog config JSON file |
| fetch-release-information | ❌ | "false" | Will enable fetching additional release information from tags. |
| fetch-reviewers | ❌ | "false" | Will enable fetching the users/reviewers who approved the PR. |
| old-tag | ❌ | "" | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) |
| github-token | ✅ | - | The GitHub token for committing the changes |
| new-tag | ✅ | - | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) |
| changelog-file | ❌ | "CHANGELOG.md" | Path to the Changelog.md file |
| commit-mode | ❌ | "false" | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. |
| config | ❌ | "" | Path to the changelog config JSON file |
| fetch-release-information | ❌ | "false" | Will enable fetching additional release information from tags. |
| fetch-reviewers | ❌ | "false" | Will enable fetching the users/reviewers who approved the PR. |
| old-tag | ❌ | "" | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) |

## Outputs

Expand Down
14 changes: 7 additions & 7 deletions actions/checkout/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ This workflow is built from other composite actions listed below:

| Name | Required | Default Value | Type | Description |
| ------------------- | :------: | :------------------------: | :----: | ------------------------------------------------------------------------------------------------------------ |
| cache | ❌ | "true" | string | Whether to cache the LFS files in this repository. This variable has an impact only if lfs is set to `true`. |
| fetch-depth | ❌ | "1" | string | Number of commits to fetch. 0 indicates all history for all branches and tags. |
| lfs | ❌ | "false" | string | Define whether to use LFS files. |
| persist-credentials | ❌ | "true" | string | Whether to configure the token or SSH key with the local git config. |
| ref | ❌ | "" | string | The branch, tag or SHA to checkout. |
| repository | ❌ | "${{ github.repository }}" | string | The repository name with owner. |
| token | ❌ | "${{ github.token }}" | string | Personal access token (PAT) used to fetch the repository. |
| cache | ❌ | "true" | string | Whether to cache the LFS files in this repository. This variable has an impact only if lfs is set to `true`. |
| fetch-depth | ❌ | "1" | string | Number of commits to fetch. 0 indicates all history for all branches and tags. |
| lfs | ❌ | "false" | string | Define whether to use LFS files. |
| persist-credentials | ❌ | "true" | string | Whether to configure the token or SSH key with the local git config. |
| ref | ❌ | "" | string | The branch, tag or SHA to checkout. |
| repository | ❌ | "${{ github.repository }}" | string | The repository name with owner. |
| token | ❌ | "${{ github.token }}" | string | Personal access token (PAT) used to fetch the repository. |

### Outputs

Expand Down
14 changes: 7 additions & 7 deletions actions/commit-and-push/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ This composite action commits the changes of your repository with an arbitrary c

| Name | Required | Default Value | Description |
| ----------------- | :------: | :-------------------------------: | -------------------------------------------------- |
| github-username | ✅ | - | The GitHub username for committing the changes |
| github-email | ✅ | - | The GitHub email for committing the changes |
| github-token | ✅ | - | The GitHub token for committing the changes |
| commit-message | ✅ | - | The commit message |
| ref | ❌ | Default branch of your repository | The ref name to commit and push the files on |
| add-untracked | ❌ | "false" | Whether to add untracked files to commit |
| pass-empty-commit | ❌ | "false" | Whether to exit with code 0 when nothing to commit |
| github-username | ✅ | - | The GitHub username for committing the changes |
| github-email | ✅ | - | The GitHub email for committing the changes |
| github-token | ✅ | - | The GitHub token for committing the changes |
| commit-message | ✅ | - | The commit message |
| ref | ❌ | Default branch of your repository | The ref name to commit and push the files on |
| add-untracked | ❌ | "false" | Whether to add untracked files to commit |
| pass-empty-commit | ❌ | "false" | Whether to exit with code 0 when nothing to commit |

## Usage

Expand Down
12 changes: 6 additions & 6 deletions actions/docker-build/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Ensure that your Dockerfile is uploaded to the repository you want to use this a

| Name | Required | Default Value | Description |
| ------------------- | :------: | :--------------------------: | -------------------------------------------------------------------------------------------------------------------- |
| docker-context | ❌ | "." | The docker context. |
| dockerfile-path | ❌ | "Dockerfile" | Path to the Dockerfile. |
| image-name | ❌ | github.event.repository.name | Name of Docker image on Dockerhub |
| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact |
| retention-days | ❌ | 1 | Number of days the image artifact should be stored on GitHub |
| working-directory | ❌ | "." | Working directory for your Docker artifacts |
| docker-context | ❌ | "." | The docker context. |
| dockerfile-path | ❌ | "Dockerfile" | Path to the Dockerfile. |
| image-name | ❌ | github.event.repository.name | Name of Docker image on Dockerhub |
| image-artifact-name | ❌ | "image-artifact" | Name of the artifact that contains the Docker image.tar file to push, see https://github.com/actions/upload-artifact |
| retention-days | ❌ | 1 | Number of days the image artifact should be stored on GitHub |
| working-directory | ❌ | "." | Working directory for your Docker artifacts |

## Usage

Expand Down
12 changes: 6 additions & 6 deletions actions/docker-publish/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Create an action that [uploads a tarball image as an artifact](https://github.co

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

## Usage

Expand Down
10 changes: 5 additions & 5 deletions actions/docker-push/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Have a Docker image with name `${{ image-name }}` available in the Docker contex

| Name | Required | Default Value | Description |
| ----------------- | :------: | :------------------------------------------------: | ------------------------------------------- |
| docker-registry | ❌ | "" | Host where the image should be pushed to |
| image-namespace | ❌ | "" | Namespace of Docker image |
| image-name | ❌ | github.event.repository.name | Name of Docker image |
| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image |
| working-directory | ❌ | "." | Working directory for your Docker artifacts |
| docker-registry | ❌ | "" | Host where the image should be pushed to |
| image-namespace | ❌ | "" | Namespace of Docker image |
| image-name | ❌ | github.event.repository.name | Name of Docker image |
| image-tag | ❌ | pipeline-${{ github.run_id }}-git-${GITHUB_SHA::8} | Tag of Docker image |
| working-directory | ❌ | "." | Working directory for your Docker artifacts |

## Usage

Expand Down
Loading

0 comments on commit 22a0ece

Please sign in to comment.