Skip to content

Commit

Permalink
Merge pull request #69 from leighmcculloch/patch-1
Browse files Browse the repository at this point in the history
Add defaults to commonly set fields to reduce setup
  • Loading branch information
svenstaro committed May 28, 2022
2 parents 1d71c23 + 8d45355 commit 8ec375d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ It runs on all operating systems types offered by GitHub.

You must provide:

- `repo_token`: Usually you'll want to set this to `${{ secrets.GITHUB_TOKEN }}`.
- `file`: A local file to be uploaded as the asset.
- `tag`: The tag to upload into. If you want the current event's tag or branch name, use `${{ github.ref }}` (the `refs/tags/` and `refs/heads/` prefixes will be automatically stripped).

Optional Arguments

- `repo_token`: Defaults to `github.token`.
- `tag`: The tag to upload into. If you want the current event's tag or branch name, use `${{ github.ref }}` (the `refs/tags/` and `refs/heads/` prefixes will be automatically stripped). Defaults to `github.ref`.
- `asset_name`: The name the file gets as an asset on a release. Use `$tag` to include the tag name. When not provided it will default to the filename.
This is not used if `file_glob` is set to `true`.
- `file_glob`: If set to true, the file argument can be a glob pattern (`asset_name` is ignored in this case) (Default: `false`)
Expand Down
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ inputs:
repo_token:
description: 'GitHub token.'
required: true
default: ${{ github.token }}
file:
description: 'Local file to upload.'
required: true
tag:
description: 'Tag to use as a release.'
required: true
default: ${{ github.ref }}
asset_name:
description: 'Name of the asset. When not provided will use the file name. Unused if file_glob is set to "true".'
overwrite:
Expand Down

0 comments on commit 8ec375d

Please sign in to comment.