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

Fix: Updated README to include correct CLI installation procedure.
All checks were successful
Test Action / test (push) Successful in 5s
Details

Browse Source
This commit is contained in:
Sławek Koszewski
2026-01-11 11:02:44 +01:00
parent 620da93338
commit 41c3945650
1 changed files with 22 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -19,28 +19,32 @@ Add the action to your workflow. Authenticate with `github.token` (default) or a
Install the CLI tool on any destination system with Node.js 24 or newer. Install the CLI tool on any destination system with Node.js 24 or newer.
**Using npx (Quick Run):**
```bash
npx install-github-release rclone/rclone
```
**Global Installation:**
```bash
npm install -g install-github-release
install-github-release rclone/rclone
```
**From Source:** **From Source:**
1. Clone the repository:
```bash ```bash
git clone https://github.com/koszewscy/setup-github-release git clone https://github.com/koszewscy/setup-github-release
cd setup-github-release cd setup-github-release
```
2. Install dependencies and build the project:
```bash
npm install npm install
npm run build npm run build
# The CLI is available at dist/cli.js ```
node dist/cli.js <repository>
3. Install the tool locally:
```bash
npm install -g .
```
After installation, the tool will be available as `install-github-release`:
```bash
install-github-release rclone/rclone
``` ```
## Features ## Features
@@ -71,7 +75,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: skoszewski/setup-github-release@v1 uses: koszewscy/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
@@ -83,7 +87,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: skoszewski/setup-github-release@v1 uses: koszewscy/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
@@ -94,7 +98,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: skoszewski/setup-github-release@v1 - uses: koszewscy/setup-github-release@v1
with: with:
repository: 'owner/repo' repository: 'owner/repo'
debug: true debug: true