Skip to content

▶️ GitHub Action using Coursier to install JVM and Scala tools

License

Notifications You must be signed in to change notification settings

coursier/setup-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Coursier setup GitHub Action

A GitHub Action to install Coursier and use it to install Java and Scala CLI tools.

It can be useful if you want to install a specific version of JVM or use a build tool like mill or seed.

Inspired by olafurpg/setup-scala and the blog post Single command Scala setup by Alex Archambault (author of Coursier).

Features

  • run it on any platform: Linux, MacOS, Windows
  • install any JVM you need
  • setup the build tool of your choice: sbt, mill, seed, etc.
  • install other common Scala CLI tools: Ammonite, Bloop, giter8, etc.

Inputs

  • jvm (optional): JVM to install

    • one of the options from cs java --available.
    • if left empty either the existing JVM will be used or Coursier will install its default JVM.
  • jvm-index (optional): The JVM index source

    • arbitrary URL containing the JVM index source like in cs java --available --jvm-index https://url/of/your/index.json.
    • if left empty the coursier index will be used as default JVM index source
  • apps (optional): Scala apps to install (sbtn by default)

  • customRepositories (optional): ''

  • disableDefaultRepos (optional): 'false'

    • Whether or not to pass the --no-default flag to coursier

Example with custom inputs

  steps:
    - uses: actions/checkout@v2
    - uses: coursier/setup-action@v1
      with:
        jvm: adopt:11
        jvm-index: https://url/of/your/index.json
        apps: sbtn bloop ammonite
        disableDefaultRepos: true
        customRepositories: https://packages.corp.com/maven

Outputs

  • cs-version: version of the installed Coursier (should be the latest available)

Caching

This action should work well with the official Coursier cache-action. For example:

  steps:
    - uses: actions/checkout@v2
    - uses: coursier/cache-action@v6
    - uses: coursier/setup-action@v1