Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bogdanp/setup-racket
A GH action for installing Racket.
https://github.com/bogdanp/setup-racket
actions racket
Last synced: 4 days ago
JSON representation
A GH action for installing Racket.
- Host: GitHub
- URL: https://github.com/bogdanp/setup-racket
- Owner: Bogdanp
- License: mit
- Created: 2019-11-02T10:27:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T05:39:56.000Z (4 months ago)
- Last Synced: 2024-12-16T02:05:28.282Z (11 days ago)
- Topics: actions, racket
- Language: JavaScript
- Size: 2.03 MB
- Stars: 52
- Watchers: 9
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# setup-racket
This action sets up a Racket environment for use in GitHub Actions.
## Usage
See [action.yml](action.yml) and [this article][article] for a
tutorial on how to use it.
### Basic
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64' # or: 'x64', 'x86', 'arm32', 'arm64' (or 'aarch64')
distribution: 'full' # or: 'minimal' (but you probably don't want 'minimal', see note at the bottom of this doc)
variant: 'CS' # or: 'BC' for Racket Before Chez
version: '8.14' # or: 'stable' for the latest version, 'current' for the latest snapshot, 'pre-release' for the latest pre-release build
- run: racket hello.rkt
```
### Package Installation
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64'
distribution: 'full'
variant: 'CS'
version: '8.14'
- run: raco pkg install --auto component koyo
- run: racket hello.rkt
```
### Caching
You can use [actions/cache] in combination with `setup-racket` to
reduce the time spent installing dependencies. See [this repo][cache]
for an example.
### Custom Locations (only on Linux)
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64'
distribution: 'full'
variant: 'CS'
version: '8.14'
dest: '/opt/racket' # ignored on macOS and Windows
- run: racket hello.rkt
```
When `dest` is provided, the destination installation's `bin` folder
is prepended to the `PATH`. When you install multiple Racket versions
to separate destinations, the last one you install will be the one
that's found in the `PATH` when you invoke `racket` from a shell
(unless you use an absolute path).
### Disable sudo
Only on Linux. The default is to use `sudo` if the command exists.
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64'
distribution: 'full'
variant: 'CS'
version: '8.14'
dest: '$GITHUB_WORKSPACE/racket'
sudo: never # either 'always' or 'never'
- run: "$GITHUB_WORKSPACE/racket/bin/racket" hello.rkt
```
### Matrix Testing
```yaml
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
racket-version: [ '8.11', '8.12', '8.13', '8.14' ]
name: Racket ${{ matrix.racket-version }} sample
steps:
- uses: actions/checkout@master
- name: Setup Racket
uses: Bogdanp/[email protected]
with:
architecture: x64
version: ${{ matrix.racket-version }}
- run: racket hello.rkt
```
### Local Package Catalogs
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64'
distribution: 'minimal'
variant: 'CS'
version: '8.14'
dest: '/opt/racket'
sudo: never
local_catalogs: $GITHUB_WORKSPACE
```
This sets up a local package catalog at `$GITHUB_WORKSPACE/catalog`
that has higher priority than the catalogs that come with the Racket
distribution. This can come in handy when testing libraries that are
a part of the main Racket distribution.
You can provide multiple local catalog paths by separating them with
commas. They are prepended to the catalog set in order so the first
local catalog in the list will have the highest priority.
### Snapshot Sites
By default, snapshots are downloaded from whichever snapshot site
(between the [Utah snapshot site] and the [Northwestern site]) has
built a snapshot most recently. You can select a specific snapshot
site using the `snapshot_site` option.
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
architecture: 'x64'
distribution: 'full'
variant: 'CS'
version: 'current'
snapshot_site: 'northwestern' # or: 'auto', 'utah' (defaults to 'auto')
- run: racket hello.rkt
```
[Utah snapshot site]: https://users.cs.utah.edu/plt/snapshots/
[Northwestern site]: https://plt.cs.northwestern.edu/snapshots/
## Gotchas
### `minimal` vs `full` distribution
Using the `full` distribution instead of the `minimal` distribution
will reduce your build times for most use cases. Things you typically
do in CI (run tests, build docs, etc.) require many dependencies not
included in the `minimal` distribution, so you waste a lot of time
downloading and installing those dependencies. The `full` distribution
comes with those dependencies pre-installed. Only use the `minimal`
distribution if you really know what you're doing.
### CPU Architecture Notes
Installers for `arm32` are only currently available when the `version`
is `current` and `arm64` installers are currently not available at
all.
Installers for Apple Silicon Macs are available when the version is
`current` and the arch is either `arm64` or `aarch64`.
### Using `racket/gui`
Tests which require `racket/gui`, even without using any graphical
features, will fail due to not having a display. To get around this,
use [gabrielbb/xvfb-action] to run your code like so:
```yaml
steps:
- uses: actions/checkout@master
- uses: Bogdanp/[email protected]
with:
version: 'stable'
- uses: GabrielBB/xvfb-action@v1
with:
run: racket hello.rkt
```
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE).
[article]: https://defn.io/2020/05/05/github-actions-for-racket-revised/
[actions/cache]: https://github.com/actions/cache
[cache]: https://github.com/Bogdanp/setup-racket-cache-example
[gabrielbb/xvfb-action]: https://github.com/marketplace/actions/gabrielbb-xvfb-action