# get-github-release

> Run any GitHub release binary

Latest version **1.0.4** (published 2020-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-github-release
pnpm add get-github-release
yarn add get-github-release
bun add get-github-release
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-02-24 |
| First published | 2020-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 304.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Maintainers | xampprocky |

## Links

- npm: https://www.npmjs.com/package/get-github-release
- Repository: https://github.com/XAMPPRocky/get-github-release
- Homepage: https://github.com/XAMPPRocky/get-github-release#readme
- Issues: https://github.com/XAMPPRocky/get-github-release/issues
- npm.io page: https://npm.io/package/get-github-release

## Dependencies (4)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [@actions/core](https://npm.io/package/@actions/core.md) ^1.1.1
- [@actions/exec](https://npm.io/package/@actions/exec.md) ^1.0.1
- [@actions/github](https://npm.io/package/@actions/github.md) ^2.0.1

## Recent versions

- 1.0.4 (latest) — 2020-02-24
- 1.0.3 — 2020-02-24
- 1.0.2 — 2020-02-22
- 1.0.1 — 2020-02-22

## README

# get-github-release

The `get-github-release` action allows you to get any binary release on GitHub.
See [`actions.yml`] for configuration options.

[`actions.yml`]: ./actions.yml

## Example
This example builds an mdbook project on linux.

```yaml
- uses: XAMPPRocky/get-github-release@v1
  with:
    matches: unknown-linux-gnu
    owner: rust-lang
    repo: mdbook
    token: "${{ secrets.GITHUB_TOKEN }}"
```

## Development

The action is written in NodeJS 12, and you can install the dependencies with:

```
npm install
```

### Running

```
npm start
```

GitHub Actions requires all the dependencies to be committed, so before
creating a commit you need to run:

```
npm run build
```

The command will bundle everything in `dist/index.js`. That file will need to
be committed.

---
_Source: https://npm.io/package/get-github-release · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._