Skip to content

Commit

Permalink
docs: add @AButler as a contributor
Browse files Browse the repository at this point in the history
  • Loading branch information
AButler committed Nov 20, 2023
1 parent 2987c0e commit 431c97d
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 7 deletions.
25 changes: 25 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"projectName": "upload-release-assets",
"projectOwner": "AButler",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"commitConvention": "angular",
"contributors": [
{
"login": "AButler",
"name": "Andrew Butler",
"avatar_url": "https://avatars.githubusercontent.com/u/1628649?v=4",
"profile": "https://github.com/AButler",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 7,
"linkToUsage": true
}
52 changes: 45 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,64 @@
## Upload Release Assets - GitHub Action
# Upload Release Assets - GitHub Action

<a href="https://github.com/AButler/upload-release-assets"><img alt="GitHub Actions status" src="https://github.com/AButler/upload-release-assets/workflows/CI/badge.svg"></a>

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

The Upload Release Assets GitHub Action uploads files (base on a glob) to a GitHub release. This is a cross-platform action that runs on any environment.

### Usage
## Usage

```yml
jobs:
build:
# ...
steps:
- uses: AButler/upload-release-assets@v2.0
- uses: AButler/upload-release-assets@v3.0
with:
files: 'artifacts/*;packages/*.nupkg'
files: "artifacts/*;packages/*.nupkg"
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
### Inputs
## Inputs
| Name | Description | Examples |
|---------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| ------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `files` | The glob of files to upload (semicolon separate multiple globs) | `file.txt` <br> `file*.txt` <br> `file_{a,b}.txt;*.json` |
| `repo-token` | The GitHub token to use to amend the release _(recommended to use `${{ secrets.GITHUB_TOKEN }}`)_ | `${{ secrets.GITHUB_TOKEN }}` |
| `release-tag` | _(Optional)_ Specify the tag of the release to upload to | `v1.0.0` |
| `release-id` | _(Optional)_ Explicitly specify the release id | `42` |
| `release-tag` | _(Optional)_ Explicity specify the tag of the release | `v1.0.0` |

If `release-id` is specified, then this release with this will be used.
If `release-tag` is specified, the release with this tag will be used.
If neither are specified, the release from the action is used.

## Contributors

A big thanks to those who have contributed to this repo:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AButler"><img src="https://avatars.githubusercontent.com/u/1628649?v=4?s=100" width="100px;" alt="Andrew Butler"/><br /><sub><b>Andrew Butler</b></sub></a><br /><a href="https://github.com/AButler/upload-release-assets/commits?author=AButler" title="Code">💻</a></td>
</tr>
</tbody>
<tfoot>
<tr>
<td align="center" size="13px" colspan="7">
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
</img>
</td>
</tr>
</tfoot>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

0 comments on commit 431c97d

Please sign in to comment.