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` | `""` | - + ## Inputs | parameter | description | required | default | @@ -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` | | - + - + - + ## Runs This action is a `composite` action. - + ## Runs This action is a `composite` action. - + diff --git a/prerelease/README.md b/prerelease/README.md index b079b66..daa9ed1 100644 --- a/prerelease/README.md +++ b/prerelease/README.md @@ -1,34 +1,37 @@ # GitHub Action Pre-release - + ## Description GitHub Action that produces a new pre-release (snapshot) of a golang based repository. - + - + ## Inputs | name | description | required | default | | --- | --- | --- | --- | | `checkout-repo` |Perform checkout as first step of action
| `false` | `true` | +| `checkout-fetch-depth` |The number of commits to fetch. 0 indicates all history for all branches and tags
| `false` | `0` | +| `create-prerelease` |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
| `false` | `false` | | `github-token` |GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'
| `true` | `""` | | `go-version` |Go version to use for building
| `true` | `1.17.3` | | `push-docker-snapshot` |If a docker snapshot image is generated, push it to the to the registry
| `false` | `false` | | `docker-username` |Docker username to push the snapshot image to the registry
| `false` | `""` | | `docker-password` |Docker password to push the snapshot image to the registry
| `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.
| `false` | `@open-turo/semantic-release-config ` | + - + ## Outputs | name | description | | --- | --- | | `version` |Version of the project
| - + ## Outputs | parameter | description | @@ -36,7 +39,7 @@ GitHub Action that produces a new pre-release (snapshot) of a golang based repos | version | Version of the project | - + ## Runs This action is a `composite` action. diff --git a/release/README.md b/release/README.md index 59bcd16..45da6f6 100644 --- a/release/README.md +++ b/release/README.md @@ -1,11 +1,11 @@ # GitHub Action Release - + ## Description GitHub Action that produces a new Release of a golang based repository. - + ## Description GitHub Action that produces a new Release of a golang based repository. @@ -13,15 +13,18 @@ GitHub Action that produces a new Release of a golang based repository. - + ## Inputs | name | description | required | default | | --- | --- | --- | --- | | `checkout-repo` |Perform checkout as first step of action
| `false` | `true` | +| `checkout-fetch-depth` |The number of commits to fetch. 0 indicates all history for all branches and tags
| `false` | `0` | | `github-token` |GitHub token that can checkout the consumer repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'
| `true` | `""` | | `go-version` |Go version to use for building
| `true` | `1.17.3` | - +| `dry-run` |Whether to run semantic release in dry-run mode. It will override the dryRun attribute in your configuration file
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.
| `false` | `@open-turo/semantic-release-config ` | + ## Inputs | parameter | description | required | default | @@ -31,13 +34,13 @@ GitHub Action that produces a new Release of a golang based repository. | go-version | Go version to use for building | `true` | 1.17.3 | - + ## Outputs | name | description | | --- | --- | | `version` |Version of the project
| - + ## Outputs | parameter | description | @@ -45,17 +48,17 @@ GitHub Action that produces a new Release of a golang based repository. | version | Version of the project | - + ## Runs This action is a `composite` action. - + ## Runs This action is a `composite` action. - + ## Usage ```yaml @@ -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' # @@ -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 ``` - + diff --git a/test/README.md b/test/README.md index f3edc6f..aa4d8b9 100644 --- a/test/README.md +++ b/test/README.md @@ -1,11 +1,11 @@ # GitHub Action Test - + ## Description GitHub Action that executes unit tests present anywhere within a golang based GitHub repository and reports results including coverage metrics - + ## Description GitHub Action that executes unit tests present anywhere within a golang based GitHub repository and reports results including coverage metrics @@ -13,14 +13,14 @@ GitHub Action that executes unit tests present anywhere within a golang based Gi - + ## Inputs | name | description | required | default | | --- | --- | --- | --- | | `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` | `""` | - + ## Inputs | --- | --- | --- | --- | @@ -28,23 +28,23 @@ GitHub Action that executes unit tests present anywhere within a golang based Gi | github-token | GitHub token that can checkout the consumer repository. e.g. 'secrets.GITHUB_TOKEN' | `true` | | - + - + - + ## Runs This action is a `composite` action. - + ## Runs This action is a `composite` action. - + ## Usage ```yaml @@ -62,6 +62,6 @@ This action is a `composite` action. # Required: true # Default: "" ``` - +