GitHub Action
setup-scala
A GitHub Action to install Java via Jabba and sbt.
- Configurable Java version: supports OpenJDK, GraalVM, Zulu and any other Java version that's installable via Jabba.
- The
sbt
command is installed using the paulp/sbt-extras launcher. - For faster startup, the
csbt
command is installed using the Coursier-based coursier/sbt-extras launcher. This launcher does not work with all builds, only usecsbt
if you know what you are doing. - Cross-platform: works on Linux, macOS, Windows.
In your GitHub Actions workflow, add a uses:
declaration before calling the
sbt
command.
+++ .github/workflows/ci.yml
name: CI
on:
push:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
+ - uses: olafurpg/setup-scala@v5
- name: Compile
run: sbt compile
The default Java version is the latest OpenJDK 8 HotSpot version via
AdoptOpenJDK. To customize the Java version add a
with:
declaration. For example, to use the latest AdoptOpenJDK 11 version
+++ .github/workflows/ci.yml
name: CI
on:
push:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: olafurpg/setup-scala@v5
+ with:
+ java-version: adopt@1.11
- name: Compile
run: sbt compile
More Java version examples:
graalvm@
: the latest GraalVMopenjdk@1.14
: the latest OpenJDK 14 versionzulu@1.11
: the latest Zulu OpenJDK 11
Some suggestions that may be helpful when using GitHub Actions.
By default, GitHub Actions stops running jobs on the first failure. Add the following configuration to ensure that all jobs run on every PR even if one job fails.
+++ .github/workflows/ci.yml
name: CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
steps:
- uses: actions/checkout@v1
- uses: olafurpg/setup-scala@v2
- name: Compile
run: sbt compile
Searching through large logs in the GitHub Actions web UI can be slow sometimes. It can be faster to look at the raw logs instead.
When running jobs on Windows, you may want to default to the bash
shell and
configure git to disable Windows line feeds.
+++ .github/workflows/ci.yml
name: CI
on: [push]
jobs:
build:
- runs-on: ubuntu-latest
+ runs-on: windows-latest
steps:
+ - name: Configure git
+ run: "git config --global core.autocrlf false"
+ shell: bash
- uses: actions/checkout@v1
- uses: olafurpg/setup-scala@v2
- name: Compile
+ shell: bash
run: sbt compile
Your repository can have a lot of commits, or branches with bulk resources.
The v2 version of actions/checkout
doesn't fetch a whole repo by default
that can speed up builds greatly. But an additional configuration can be
required to fetch tags up to some level of depth for some builds which check
binary compatibility with previous tagged release from the branch.
+++ .github/workflows/ci.yml
name: CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v1
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: 100
+ - name: Fetch tags
+ run: git fetch --depth=100 origin +refs/tags/*:refs/tags/*
- uses: olafurpg/setup-scala@v2
- name: Compile
run: sbt compile