Skip to content

Commit 457e204

Browse files
committed
[ci skip] README.md changes
1 parent 0fd8b05 commit 457e204

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ It is made in python + docker... cause that's the languages I know
1717

1818
### Input variables this action takes
1919

20-
Input Name | Description
21-
-----------|------------
22-
token | **Required.** The token this action should use for accessing the GitHub API. Most often you'll want to set this to `${{ secrets.GITHUB_TOKEN }}`
23-
tag | **Required.** Name of the tag for the release.
24-
name | **Required for new releases.** The title of the release. If not set, the title will not be changed... unless the release does not exist; then it'll fail
25-
description | **Required for new releases.** The description of the release. If not set, the description will not be changed... unless the release does not exist; then it'll fail
26-
prerelease | **Optional.** Whether the release should be marked as a prerelease. Accepted values: true, false. Defaults to false for new releases, keeps the current setting for existing releases
27-
draft | **Optional.** Whether the release should be marked as a draft. Accepted values: true, false. Defaults to false for new releases, keeps the current setting for existing releases
28-
target_commit | **Optional.** Commit, branch or tag (or anything `git rev-parse` can resolve) the release tag should be created at or moved to. Defaults to `$GITHUB_SHA`, aka. the "current" commit.
29-
files | **Optional.** A newline seperated list of files to attach to the release. Recursive globbing is supported (anything the python `glob.glob()` function can resolve).
30-
fail_on_no_files | **Optional.** Should the action fail if no filename globs match? Does nothing if no files were listed. Accepted values: true, false. Default: false.
31-
clear_attachments | **Optional.** Should we remove all existing attachments from the release before adding new ones? Accepted values: true, false. Default: false.
20+
| Input Name | Description |
21+
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22+
| token | **Required.** The token this action should use for accessing the GitHub API. Most often you'll want to set this to `${{ secrets.GITHUB_TOKEN }}` |
23+
| tag | **Required.** Name of the tag for the release. |
24+
| name | **Required for new releases.** The title of the release. If not set, the title will not be changed... unless the release does not exist; then it'll fail |
25+
| description | **Required for new releases.** The description of the release. If not set, the description will not be changed... unless the release does not exist; then it'll fail |
26+
| prerelease | **Optional.** Whether the release should be marked as a prerelease. Accepted values: true, false. Defaults to false for new releases, keeps the current setting for existing releases |
27+
| draft | **Optional.** Whether the release should be marked as a draft. Accepted values: true, false. Defaults to false for new releases, keeps the current setting for existing releases |
28+
| target_commit | **Optional.** Commit, branch or tag (or anything `git rev-parse` can resolve) the release tag should be created at or moved to. Defaults to `$GITHUB_SHA`, aka. the "current" commit. |
29+
| files | **Optional.** A newline seperated list of files to attach to the release. Recursive globbing is supported (anything the python `glob.glob()` function can resolve). |
30+
| fail_on_no_files | **Optional.** Should the action fail if no filename globs match? Does nothing if no files were listed. Accepted values: true, false. Default: false. |
31+
| clear_attachments | **Optional.** Should we remove all existing attachments from the release before adding new ones? Accepted values: true, false. Default: false. |
3232

3333
### Environment variables this action uses
3434
Only default environment variables: `$GITHUB_SHA`, `$GITHUB_API_URL` and `$GITHUB_REPOSITORY`
@@ -73,7 +73,7 @@ jobs:
7373
# would go here
7474
#
7575
- name: Release the new binaries
76-
uses: mini-bomba/create-github-release@v1.1.2
76+
uses: mini-bomba/create-github-release@v1.1.3
7777
with:
7878
token: ${{ secrets.GITHUB_TOKEN }}
7979
tag: "latest"
@@ -96,11 +96,11 @@ selfhosted runner's disk space, you can use the prebuilt images instead.
9696
9797
To replace the action with the prebuilt image, simply replace
9898
```yaml
99-
uses: mini-bomba/create-github-release@v1.1.2
99+
uses: mini-bomba/create-github-release@v1.1.3
100100
```
101101
with
102102
```yaml
103-
uses: docker://ghcr.io/mini-bomba/create-github-release:v1.1.2
103+
uses: docker://ghcr.io/mini-bomba/create-github-release:v1.1.3
104104
```
105105
in your workflows.
106106

0 commit comments

Comments
 (0)