actions/release-action
actions/release-action
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme [skip-ci]

Browse source
This commit is contained in:
Andres Almiray 2021-03-29 00:11:54 +02:00
parent ab86c3419f
commit 642a230e7f
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.adoc
View file

@ -71,11 +71,11 @@ to be located at the root of the repository.
Following inputs can be used as `step.with` keys Following inputs can be used as `step.with` keys
[%header] [%header,width="100%"]
|=== |===
| Name | Type | Default | Description | Name | Type | Default | Description
| version | String | early-access | The JReleaser version to use. Should match any of the | version | String | early-access | The JReleaser version to use. +
link:https://github.com/jreleaser/jreleaser/releases[published releases]. Should match any of the link:https://github.com/jreleaser/jreleaser/releases[published releases].
| arguments | String | full-release | The JReleaser command to run. | arguments | String | full-release | The JReleaser command to run.
|=== |===
@ -83,7 +83,7 @@ link:https://github.com/jreleaser/jreleaser/releases[published releases].
Following environment variables can be used as `step.env` keys Following environment variables can be used as `step.env` keys
[%header] [%header,width="100%"]
|=== |===
| Name | Description | Name | Description
| JRELEASER_GITHUB_TOKEN | link:https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token[GITHUB_TOKEN] | JRELEASER_GITHUB_TOKEN | link:https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token[GITHUB_TOKEN]
@ -120,6 +120,7 @@ you may apply the `GH_PAT` token as follows
JRELEASER_HOMEBREW_GITHUB_TOKEN: ${{ secrets.GH_PAT }} JRELEASER_HOMEBREW_GITHUB_TOKEN: ${{ secrets.GH_PAT }}
---- ----
Additional environment variables may be needed depending on your specific setup. Review the docs at Additional environment variables may be needed depending on your specific setup, such as those needed for signing files
link:https://jreleaser.org[]. with GPG or announcing a release via Twitter. Review the docs at link:https://jreleaser.org[] to find more about these
variables and how to set them up.