prantlf/Install Released Tool
GitHub action for downloading, extracting, caching an executable from a GitHub release and putting it to PATH.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| repo | Specify the repository in the form `owner/name` to download the archive with the executable from. Mandatory. | yes | — |
| version | Specify the version of the executable to download and extract. It can be `latest` (the latest published semantic version) or a semantic version number in the form of a git tag (usually `vX.Y.Z`, but sometimes only `X.Y.Z`), or any semantic version specification. | — | latest |
| name | Specify the name prefix of the archive to download and the name of the the executable to extract from it. If not specified, the first archive named `{name}-{platform}-{architecture}.zip` will be picked and the prefix `name` will be used. | — | — |
| platforms | A map where keys are Node.js platforms and values are their aliases which will be recognised in names of the installation archives. The Node.js platform name itself doesn't have to be included in the aliases. This input is a multi-line string, where each line is a map entry. The kay is separated from the value by colon (:). Aliases are separated by commas (,). | — | darwin:macos linux: win32:windows |
| architectures | A map where keys are Node.js architectures and values are their aliases which will be recognised in names of the installation archives. The Node.js architectures name itself doesn't have to be included in the aliases. This input is a multi-line string, where each line is a map entry. The kay is separated from the value by colon (:). Aliases are separated by commas (,). | — | arm64:aarch64 riscv64: x64:amd64,x86_64,x86 |
| use-cache | Set to `false` to ignore the cache and always perform the full installation by downloading and unpacking a binary. | — | true |
| token | Authorization token to inspect releases and commits in the `{repo}` repository. Either a GitHub personal access token or the GitHub workflow token. And if even that is not set, the GitHub workflow token from the action-execution context will be used as default. | — | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| version | The actually installed version of the executable, as returned by `{executable} -V`. |
| bin-path | The complete path to the directory with the extracted. |
| exe-path | The complete path to the extracted executable. |
| used-cache | A boolean value indicating if the installation succeeded from the cache. |