Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GitHub Action to just test on macOS, Ubuntu, and Windows #1867

Merged
merged 1 commit into from
Jan 27, 2024
Merged

GitHub Action to just test on macOS, Ubuntu, and Windows #1867

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 38 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,23 +305,57 @@ export PATH="$PATH:$HOME/bin"
just --help
```

Note that `install.sh` may fail on GitHub actions, or in other environments
Note that `install.sh` may fail on GitHub Actions, or in other environments
where many machines share IP addresses. `install.sh` calls GitHub APIs in order
to determine the latest version of `just` to install, and those API calls are
rate-limited on a per-IP basis. To make `install.sh` more reliable in such
circumstances, pass a specific tag to install with `--tag`.

### GitHub Actions

With [extractions/setup-just](https://github.com/extractions/setup-just):
Developers may be interested in running the same `just` commands that they use
locally on continuous integration platforms such as GitHub Actions. For example,
every time that a contributor creates a pull request, a GitHub Action could run
`just test` on the three major operating systems to provide feedback to both the
contributor and reviewers that tests are passing.

Demonstrate how to install and use just in GitHub Actions on the three major
operating systems without needing third-party GitHub Actions. Put the following
code into a `.github/workflows/just_test.yml` file.

```yaml
name: just_test
on: [pull_request, push]
jobs:
ubuntu:
runs-on: ubuntu-latest
steps:
- run: sudo snap install --edge --classic just
- uses: actions/checkout@v4
- run: just test
macos:
runs-on: macos-latest
steps:
- run: brew install just
- uses: actions/checkout@v4
- run: just test
windows:
runs-on: windows-latest
steps:
- run: choco install just
- uses: actions/checkout@v4
- run: just test
```

Or with [extractions/setup-just](https://github.com/extractions/setup-just):

```yaml
- uses: extractions/setup-just@v1
with:
just-version: 0.8 # optional semver specification, otherwise latest
just-version: 1.5.0 # optional semver specification, otherwise latest
```

With [taiki-e/install-action](https://github.com/taiki-e/install-action):
Or with [taiki-e/install-action](https://github.com/taiki-e/install-action):

```yaml
- uses: taiki-e/install-action@just
Expand Down