diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..ab6bd757 --- /dev/null +++ b/.all-contributorsrc @@ -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 +} diff --git a/README.md b/README.md index 247caa4f..25c69eb3 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,64 @@ -## Upload Release Assets - GitHub Action +# Upload Release Assets - GitHub Action GitHub Actions status + +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) + + 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`
`file*.txt`
`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: + + + + + + + + + + + + + + + +
Andrew Butler
Andrew Butler

💻
+ + Add your contributions + +
+ + + + +