actions/setup-just
1
0
Fork 0
mirror of https://github.com/extractions/setup-just synced 2026-09-14 20:13:55 +00:00
Code Packages Releases Activity

Update README

Browse Source
This commit is contained in:
Ross MacArthur
2023-02-12 09:07:30 +02:00
parent ad659545e1
commit 82fe2e1caf
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -9
View File
@@ -1,6 +1,6 @@
# 🤖 `setup-just` action # 🤖 `setup-just` action
![build](https://img.shields.io/github/workflow/status/extractions/setup-just/build) [![Build Status](https://img.shields.io/github/actions/workflow/status/extractions/setup-just/build.yaml?branch=trunk)](https://github.com/extractions/setup-just/actions/workflows/build.yaml)
This GitHub Action will install a release of the This GitHub Action will install a release of the
[just](https://github.com/casey/just) command runner for you. [just](https://github.com/casey/just) command runner for you.
@@ -24,9 +24,9 @@ If you want a specific version of `just` you can specify this by passing the
just-version: '1.4.0' just-version: '1.4.0'
``` ```
To avoid rate-limitting, the default Github token available to all actions, is To avoid rate-limiting, the default Github token available to all actions, is
automatically used to authenticate calls to Github. To override it, set the environment automatically used to authenticate calls to Github. To override it, set the
variable `GITHUB_TOKEN`. environment variable `GITHUB_TOKEN` or pass the input `github-token`.
```yaml ```yaml
- uses: extractions/setup-just@v1 - uses: extractions/setup-just@v1
@@ -34,7 +34,7 @@ variable `GITHUB_TOKEN`.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
Alternatively, you may set the input `token`. or
```yaml ```yaml
- uses: extractions/setup-just@v1 - uses: extractions/setup-just@v1
@@ -44,10 +44,10 @@ Alternatively, you may set the input `token`.
### Inputs ### Inputs
| Name | Required | Description | Type | Default | | Name | Required | Description | Type | Default |
| -------------- | -------- | --------------------------------------- | ------ | --------------------- | | -------------- | -------- | -------------------------------------------- | ------ | --------------------- |
| `just-version` | no | A valid NPM-style semver specification. | string | * | | `just-version` | no | A valid NPM-style semver specification. | string | * |
| `github-token` | no | A Github token. | string | `${{ github.token }}` | | `github-token` | no | A Github token to authenticate API requests. | string | `${{ github.token }}` |
The semver specification is passed directly to NPM's [semver The semver specification is passed directly to NPM's [semver
package](https://www.npmjs.com/package/semver). This GitHub Action will install package](https://www.npmjs.com/package/semver). This GitHub Action will install