Skip to content

Commit

Permalink
docs: ensure action-docs works correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
@tagoro9
tagoro9 committed Sep 16, 2024
1 parent 220dc13 commit cc99a02
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 40 deletions.
8 changes: 4 additions & 4 deletions integration-test/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# GitHub Action Integration-Test

<!-- prettier-ignore-start -->
<!-- action-docs-description source="integration-test/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

Conditionally executes golang integration tests via docker, if docker compose file is found
<!-- action-docs-description source="integration-test/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->

<!-- action-docs-usage source="integration-test/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
## Usage

```yaml
Expand Down Expand Up @@ -37,7 +37,7 @@ Conditionally executes golang integration tests via docker, if docker compose fi
# Required: false
# Default: false
```
<!-- action-docs-usage source="integration-test/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->

## Usage

Expand Down
18 changes: 9 additions & 9 deletions lint/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# GitHub Action Lint

<!-- prettier-ignore-start -->
<!-- action-docs-description source="lint/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that lints a Terraform based repository via [action-pre-commit](https://github.com/open-turo/action-pre-commit)
<!-- action-docs-description source="lint/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that lints a Terraform based repository via [action-pre-commit](https://github.com/open-turo/action-pre-commit)
<!-- action-docs-description -->
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
<!-- action-docs-inputs source="lint/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `checkout-repo` | <p>Perform checkout as first step of action</p> | `false` | `true` |
| `github-token` | <p>GitHub token that can checkout the consumer repository. e.g. 'secrets.GITHUB_TOKEN'</p> | `true` | `""` |
<!-- action-docs-inputs source="lint/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| parameter | description | required | default |
Expand All @@ -29,22 +29,22 @@ GitHub Action that lints a Terraform based repository via [action-pre-commit](ht
| github-token | GitHub token that can checkout the consumer repository. e.g. 'secrets.GITHUB_TOKEN' | `true` | |
<!-- action-docs-inputs -->

<!-- action-docs-outputs source="lint/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->

<!-- action-docs-outputs source="lint/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->

<!-- action-docs-outputs -->

<!-- action-docs-runs source="lint/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs source="lint/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs -->

<!-- action-docs-usage source="lint/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
<!-- action-docs-usage -->
<!-- prettier-ignore-end -->
17 changes: 10 additions & 7 deletions prerelease/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,45 @@
# GitHub Action Pre-release

<!-- prettier-ignore-start -->
<!-- action-docs-description source="prerelease/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that produces a new pre-release (snapshot) of a golang based repository.
<!-- action-docs-description source="prerelease/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
<!-- action-docs-inputs source="prerelease/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `checkout-repo` | <p>Perform checkout as first step of action</p> | `false` | `true` |
| `checkout-fetch-depth` | <p>The number of commits to fetch. 0 indicates all history for all branches and tags</p> | `false` | `0` |
| `create-prerelease` | <p>Whether semantic-release should create a prerelease or do a dry run. This can be useful to set to true when a prerelease requires pushing artifacts semantic-release is in charge of generating</p> | `false` | `false` |
| `github-token` | <p>GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'</p> | `true` | `""` |
| `go-version` | <p>Go version to use for building</p> | `true` | `1.17.3` |
| `push-docker-snapshot` | <p>If a docker snapshot image is generated, push it to the to the registry</p> | `false` | `false` |
| `docker-username` | <p>Docker username to push the snapshot image to the registry</p> | `false` | `""` |
| `docker-password` | <p>Docker password to push the snapshot image to the registry</p> | `false` | `""` |
<!-- action-docs-inputs source="prerelease/action.yaml" -->
| `extra-plugins` | <p>Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config.</p> | `false` | `@open-turo/semantic-release-config ` |
<!-- action-docs-inputs source="action.yaml" -->

<!-- action-docs-outputs source="prerelease/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->
## Outputs

| name | description |
| --- | --- |
| `version` | <p>Version of the project</p> |
<!-- action-docs-outputs source="prerelease/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->
## Outputs

| parameter | description |
| --- | --- |
| version | Version of the project |
<!-- action-docs-outputs -->

<!-- action-docs-runs source="prerelease/action.yaml -->
<!-- action-docs-runs source="action.yaml -->
## Runs

This action is a `composite` action.
Expand Down
41 changes: 31 additions & 10 deletions release/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
# GitHub Action Release

<!-- prettier-ignore-start -->
<!-- action-docs-description source="release/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that produces a new Release of a golang based repository.
<!-- action-docs-description source="release/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that produces a new Release of a golang based repository.
<!-- action-docs-description -->
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
<!-- action-docs-inputs source="release/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `checkout-repo` | <p>Perform checkout as first step of action</p> | `false` | `true` |
| `checkout-fetch-depth` | <p>The number of commits to fetch. 0 indicates all history for all branches and tags</p> | `false` | `0` |
| `github-token` | <p>GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'</p> | `true` | `""` |
| `go-version` | <p>Go version to use for building</p> | `true` | `1.17.3` |
<!-- action-docs-inputs source="release/action.yaml" -->
| `dry-run` | <p>Whether to run semantic release in <code>dry-run</code> mode. It will override the <code>dryRun</code> attribute in your configuration file</p> | `false` | `false` |
| `extra-plugins` | <p>Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config.</p> | `false` | `@open-turo/semantic-release-config ` |
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| parameter | description | required | default |
Expand All @@ -31,31 +34,31 @@ GitHub Action that produces a new Release of a golang based repository.
| go-version | Go version to use for building | `true` | 1.17.3 |
<!-- action-docs-inputs -->

<!-- action-docs-outputs source="release/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->
## Outputs

| name | description |
| --- | --- |
| `version` | <p>Version of the project</p> |
<!-- action-docs-outputs source="release/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->
## Outputs

| parameter | description |
| --- | --- |
| version | Version of the project |
<!-- action-docs-outputs -->

<!-- action-docs-runs source="release/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs source="release/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs -->

<!-- action-docs-usage source="release/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
## Usage

```yaml
Expand All @@ -67,6 +70,12 @@ This action is a `composite` action.
# Required: false
# Default: true

checkout-fetch-depth:
# The number of commits to fetch. 0 indicates all history for all branches and tags
#
# Required: false
# Default: 0

github-token:
# GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'
#
Expand All @@ -78,7 +87,19 @@ This action is a `composite` action.
#
# Required: true
# Default: 1.17.3

dry-run:
# Whether to run semantic release in `dry-run` mode. It will override the `dryRun` attribute in your configuration file
#
# Required: false
# Default: false

extra-plugins:
# Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config.
#
# Required: false
# Default: @open-turo/semantic-release-config
```
<!-- action-docs-usage source="release/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
<!-- action-docs-usage -->
<!-- prettier-ignore-end -->
20 changes: 10 additions & 10 deletions test/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
# GitHub Action Test

<!-- prettier-ignore-start -->
<!-- action-docs-description source="test/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that executes unit tests present anywhere within a golang based GitHub repository and reports results including coverage metrics
<!-- action-docs-description source="test/action.yaml" -->
<!-- action-docs-description source="action.yaml" -->
## Description

GitHub Action that executes unit tests present anywhere within a golang based GitHub repository and reports results including coverage metrics
<!-- action-docs-description -->
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
<!-- action-docs-inputs source="test/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `checkout-repo` | <p>Perform checkout as first step of action</p> | `false` | `true` |
| `github-token` | <p>GitHub token that can checkout the consumer repository. e.g. 'secrets.GITHUB_TOKEN'</p> | `true` | `""` |
<!-- action-docs-inputs source="test/action.yaml" -->
<!-- action-docs-inputs source="action.yaml" -->
## Inputs

| --- | --- | --- | --- |
| checkout-repo | Perform checkout as first step of action | `false` | true |
| github-token | GitHub token that can checkout the consumer repository. e.g. 'secrets.GITHUB_TOKEN' | `true` | |
<!-- action-docs-inputs -->

<!-- action-docs-outputs source="test/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->

<!-- action-docs-outputs source="test/action.yaml" -->
<!-- action-docs-outputs source="action.yaml" -->

<!-- action-docs-outputs -->

<!-- action-docs-runs source="test/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs source="test/action.yaml" -->
<!-- action-docs-runs source="action.yaml" -->
## Runs

This action is a `composite` action.
<!-- action-docs-runs -->

<!-- action-docs-usage source="test/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
## Usage

```yaml
Expand All @@ -62,6 +62,6 @@ This action is a `composite` action.
# Required: true
# Default: ""
```
<!-- action-docs-usage source="test/action.yaml" -->
<!-- action-docs-usage source="action.yaml" -->
<!-- action-docs-usage -->
<!-- prettier-ignore-end -->

0 comments on commit cc99a02

Please sign in to comment.