mirror of
https://github.com/extractions/setup-just
synced 2026-09-07 20:04:00 +00:00
89 lines
2.3 KiB
Markdown
89 lines
2.3 KiB
Markdown
# 🤖 `setup-just` action
|
|
|
|
|
|
|
|
This GitHub Action will install a release of the
|
|
[just](https://github.com/casey/just) command runner for you.
|
|
|
|
## Usage
|
|
|
|
### Examples
|
|
|
|
In most cases all you will need is the following in your workflow.
|
|
|
|
```yaml
|
|
- uses: extractions/setup-just@v1
|
|
```
|
|
|
|
If you want a specific version of `just` you can specify this by passing the
|
|
`just-version` input.
|
|
|
|
```yaml
|
|
- uses: extractions/setup-just@v1
|
|
with:
|
|
just-version: '1.4.0'
|
|
```
|
|
|
|
In rare circumstances you might get rate limiting errors, this is because this
|
|
workflow has to make requests to GitHub API in order to list available releases.
|
|
If this happens you can set the `GITHUB_TOKEN` environment variable.
|
|
|
|
```yaml
|
|
- uses: extractions/setup-just@v1
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
```
|
|
|
|
### Inputs
|
|
|
|
| Name | Required | Description | Type | Default |
|
|
| -------------- | -------- | --------------------------------------- | ------ | ------- |
|
|
| `just-version` | no | A valid NPM-style semver specification. | string | * |
|
|
|
|
The semver specification is passed directly to NPM's [semver
|
|
package](https://www.npmjs.com/package/semver). This GitHub Action will install
|
|
the latest matching release. Examples include
|
|
|
|
- `just-version: '*'` latest version (default).
|
|
- `just-version: '0.10'` equivalent to `>=0.10.0 <0.11.0`.
|
|
- `just-version: '0.10.x'` equivalent to `>=0.10.0 <0.11.0`.
|
|
- `just-version: '0.10.0'` equivalent to `=0.10.0`.
|
|
- `just-version: '^0.10.0'` equivalent to `>=0.10.0 <0.11.0`.
|
|
|
|
## Development
|
|
|
|
Most of the installation logic is done in a shared library located at
|
|
[@extractions/setup-crate](https://github.com/extractions/setup-crate).
|
|
|
|
The following commands are useful for development.
|
|
|
|
- `npm i`
|
|
|
|
Install all dependencies.
|
|
|
|
- `npm run fmt`
|
|
|
|
Format the source code.
|
|
|
|
- `npm run lint`
|
|
|
|
Run all lints.
|
|
|
|
- `npm run run`
|
|
|
|
Test the action by running it.
|
|
|
|
- `npm run build`
|
|
|
|
Build the action and update `dist/`.
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
|
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|