koszewscy/setup-github-release
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix: README corrections.

Browse Source
This commit is contained in:
Sławek Koszewski
2026-01-11 20:03:25 +01:00
parent 90033e0b9e
commit 483a1c5f13
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -10,7 +10,7 @@ Add the action to your workflow. Authenticate with `github.token` (default) or a
```yaml ```yaml
- name: Install Tool - name: Install Tool
uses: koszewscy/setup-github-release@v1 uses: skoszewski/setup-github-release@v1
with: with:
repository: 'owner/repo' repository: 'owner/repo'
``` ```
@@ -24,7 +24,7 @@ Install the CLI tool on any destination system with Node.js 24 or newer.
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/koszewscy/setup-github-release git clone https://github.com/skoszewski/setup-github-release
cd setup-github-release cd setup-github-release
``` ```
@@ -65,8 +65,8 @@ install-github-release rclone/rclone
The action will automatically detect your OS (Linux, Windows, macOS) and architecture (x64, ARM64) and look for a matching archive. It will search for a binary named after the repository. The action will automatically detect your OS (Linux, Windows, macOS) and architecture (x64, ARM64) and look for a matching archive. It will search for a binary named after the repository.
```yaml ```yaml
- name: Install Hugo - name: Install LEGO
uses: koszewscy/setup-github-release@v1 uses: skoszewski/setup-github-release@v1
with: with:
repository: 'go-acme/lego' repository: 'go-acme/lego'
``` ```
@@ -79,7 +79,7 @@ For projects with multiple binary versions, you can use a regex pattern (prefixe
```yaml ```yaml
- name: Install Extended Hugo - name: Install Extended Hugo
uses: koszewscy/setup-github-release@v1 uses: skoszewski/setup-github-release@v1
with: with:
repository: 'gohugoio/hugo' repository: 'gohugoio/hugo'
file-name: '~hugo_extended_[^a-z]' # Regex to match extended version file-name: '~hugo_extended_[^a-z]' # Regex to match extended version
@@ -91,7 +91,7 @@ If the binary name is different from the repository name, like in the example of
```yaml ```yaml
- name: Install GitHub CLI - name: Install GitHub CLI
uses: koszewscy/setup-github-release@v1 uses: skoszewski/setup-github-release@v1
with: with:
repository: 'cli/cli' repository: 'cli/cli'
binary-name: 'gh' # Searches for 'gh' (or 'gh.exe') inside the extracted release binary-name: 'gh' # Searches for 'gh' (or 'gh.exe') inside the extracted release
@@ -102,7 +102,7 @@ If the binary name is different from the repository name, like in the example of
If you are unsure how the binary is named, use the `debug` flag to list all files in the unpacked asset, or download the asset manually to inspect its structure. If you are unsure how the binary is named, use the `debug` flag to list all files in the unpacked asset, or download the asset manually to inspect its structure.
```yaml ```yaml
- uses: koszewscy/setup-github-release@v1 - uses: skoszewski/setup-github-release@v1
with: with:
repository: 'owner/repo' repository: 'owner/repo'
debug: true debug: true
@@ -166,7 +166,7 @@ You can also use the `check-token` subaction in your workflows:
```yaml ```yaml
- name: Verify Token - name: Verify Token
uses: koszewscy/setup-github-release/check-token@v1 uses: skoszewski/setup-github-release/check-token@v1
with: with:
repository: 'actions/checkout' # Optional, defaults to actions/checkout repository: 'actions/checkout' # Optional, defaults to actions/checkout
token: ${{ secrets.MY_TOKEN }} token: ${{ secrets.MY_TOKEN }}
@@ -203,7 +203,7 @@ The list of assets from the latest release is filtered based on the following ru
8. `{{SYSTEM}}` is replaced with the detected operating system regex: 8. `{{SYSTEM}}` is replaced with the detected operating system regex:
- For Linux: `linux`. - For Linux: `linux`.
- For MacOS: `(darwin|macos|mac|osx)`. - For MacOS: `(darwin|macos|mac)`.
- For Windows: `(windows|win)`. - For Windows: `(windows|win)`.
9. `{{ARCH}}` is replaced with the detected architecture regex: 9. `{{ARCH}}` is replaced with the detected architecture regex: