Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olafurpg/setup-scala
GitHub Action to install any version of Java (GraalVM, Java 8, Java 11, Java 14, ...) via Jabba. Works for any JVM language including Java, Scala and Kotlin.
https://github.com/olafurpg/setup-scala
actions ci github-actions sbt scala
Last synced: 4 days ago
JSON representation
GitHub Action to install any version of Java (GraalVM, Java 8, Java 11, Java 14, ...) via Jabba. Works for any JVM language including Java, Scala and Kotlin.
- Host: GitHub
- URL: https://github.com/olafurpg/setup-scala
- Owner: olafurpg
- License: mit
- Created: 2019-09-22T09:56:55.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-24T12:23:00.000Z (12 months ago)
- Last Synced: 2024-10-24T15:42:05.381Z (12 days ago)
- Topics: actions, ci, github-actions, sbt, scala
- Language: TypeScript
- Homepage:
- Size: 723 KB
- Stars: 168
- Watchers: 2
- Forks: 30
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup Scala GitHub Action
A GitHub Action to install Java via [Jabba](https://github.com/shyiko/jabba) and
sbt.
- Configurable Java version: supports OpenJDK, GraalVM, Zulu and any other Java
version that's installable via Jabba.
- Cross-platform: works on Linux, macOS, Windows.
- The `sbt` command is provided, with the official sbt launch script.
- The following alternate sbt launch scripts are also provided:
- `sbtx` runs the [sbt-extras](https://github.com/dwijnand/sbt-extras/) launcher.
- `csbt` runs the [Coursier-based sbt-extras](https://github.com/coursier/sbt-extras/) launcher.
## Usage:
In your GitHub Actions workflow, add a `uses:` declaration before calling the
`sbt` command.
```diff
+++ .github/workflows/ci.yml
name: CI
on:
push:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
+ - uses: olafurpg/setup-scala@v11
- name: Compile
run: sbt compile
```
The default Java version is the latest OpenJDK 8 HotSpot version via
[AdoptOpenJDK](https://adoptopenjdk.net/). To customize the Java version add a
`with:` declaration. For example, to use the latest AdoptOpenJDK 11 version
```diff
+++ .github/workflows/ci.yml
name: CI
on:
push:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: olafurpg/setup-scala@v11
+ with:
+ java-version: [email protected]
- name: Compile
run: sbt compile
```
More Java version examples:
- `graalvm@`: the latest GraalVM
- `[email protected]`: the latest OpenJDK 14 version
- `[email protected]`: the latest Zulu OpenJDK 11
- `[email protected]=tgz+https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-20.2.0/graalvm-ce-java11-linux-amd64-20.2.0.tar.gz`:
custom Java version from a URL
## Tips and tricks
Some suggestions that may be helpful when using GitHub Actions.
### Disable `fail-fast` strategy
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.
```diff
+++ .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@v11
- name: Compile
run: sbt compile
```
### Browsing raw logs
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.
### Configuring Windows jobs
When running jobs on Windows, you may want to default to the `bash` shell and
configure git to disable Windows line feeds.
```diff
+++ .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@v11
- name: Compile
+ shell: bash
run: sbt compile
```
### Faster checkout of big repos
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.
```diff
+++ .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@v11
- name: Compile
run: sbt compile
```