Implemented asset matching. Added a local test workflow.
Some checks failed
Test Action / test (push) Failing after 4s
Some checks failed
Test Action / test (push) Failing after 4s
This commit is contained in:
34
README.md
34
README.md
@@ -1,13 +1,37 @@
|
||||
# Setup GitHub Release Action
|
||||
# setup-github-release
|
||||
|
||||
This GitHub/Gitea Action downloads a release from a specified GitHub repository and adds it to the runners tool cache.
|
||||
This GitHub/Gitea Action downloads a tool from a GitHub release based on platform-aware selection rules and adds it to the system PATH.
|
||||
|
||||
## Usage
|
||||
|
||||
### Simple (Automatic Selection)
|
||||
The action will automatically detect your OS and ARCH and look for a matching archive.
|
||||
```yaml
|
||||
- uses: ./
|
||||
with:
|
||||
repo-name: 'owner/repo'
|
||||
file-name: 'tool-linux.*'
|
||||
use-regex: 'true'
|
||||
repo-name: 'gohugoio/hugo'
|
||||
```
|
||||
|
||||
### Regex Search
|
||||
You can use a regex pattern (prefixed with `~`) to narrow down the asset.
|
||||
```yaml
|
||||
- uses: ./
|
||||
with:
|
||||
repo-name: 'gohugoio/hugo'
|
||||
file-name: '~hugo_extended'
|
||||
```
|
||||
|
||||
### Custom File Type
|
||||
```yaml
|
||||
- uses: ./
|
||||
with:
|
||||
repo-name: 'some/repo'
|
||||
file-type: 'package' # Matches .deb, .rpm, .pkg
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
- `repo-name` (required): GitHub repository in `owner/repo` format.
|
||||
- `file-name` (optional): Literal name or regex pattern (if starts with `~`) to match the asset.
|
||||
- `file-type` (optional, default: `archive`): Predefined keywords `archive`, `package`, or a custom regex extension pattern.
|
||||
- `token` (optional): GitHub token for authentication.
|
||||
|
||||
Reference in New Issue
Block a user