coursier/setup-action

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

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)

  • space separated list of app names (from the main channel)

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

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

setup-action's Issues

Unrecognized launcher type: prebuilt

Hi!

We just started seeing the following failure in CI:

Might it be related to coursier/apps#134? Upgrade to [email protected] solves it :)

Move the major version tag `v1` to the latest stable version

Can you actualize a major version tag and move it to the latest stable version?
https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions

Make the extension work on macOS and Windows

Really great to have such an extension, thanks for it @laughedelic!

FYI, I wrote this script some time ago (but didn't talk about it much at the time). It allows to get the coursier CLI for Linux / macOS / Windows, and also downloads it via the coursier cache, so that if cache-action runs before, nothing needs to be downloaded once the launcher is in cache. It also allows one to specify the coursier CLI version upfront (but needs to be updated when new coursier versions are tagged…).

You may want to embed that script in the action here, to have this extension work on macOS and Windows too, and use the cache. One point to pay attention to though, is that the coursier version it uses needs to be part of the cache key of cache-action. (Else the cache may not be saved after bumping the coursier version.)

It might be possible to pass parameters to cache-action from this action, I'm not sure… That said, it's not that big a deal if the CLI is not cached, as it's downloaded straight from GitHub…

Allow setting of custom arguments

I am using the action on a self-hosted runner which requires proxy settings. I don't seem to be able to set these, meaning coursier fails when installing apps

I tried to set JAVA_OPTS, however this doesn't seem to be possible (not sure if this would work anyway)

My understanding is, I would need to get coursier to run like this: coursier -J-Dhttps.proxyHost=… -J-Dhttps.proxyPort=… as documented here

If this makes sense as a useful feature, I'd be willing to work on a pull request. Let me know what you think

GitHub is complaining that this action is still on node 16

at e.g. https://github.com/scala/docs.scala-lang/actions/runs/7731196638?pr=2960 we see:

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: coursier/[email protected]. For more information see: github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20.

perhaps this has already been fixed in this repo but just hasn't been released yet...?

Consider using Disco API instead of Jabba

Consider using the Disco API for all the metadata about Java distributions, vendors, platforms, URLs, etc.
https://github.com/foojay2020/discoapi

Jabba is not kept up to date. ( https://github.com/coursier/jvm-index is currently being used, but then we wouldn't need to maintain it.)
EDIT: Jabba seems to be dead shyiko/jabba#833

not installing the correct jvm

I'm using coursier/setup-action@v1
https://github.com/MasseGuillaume/porc-epic/blob/c7f39d786f24f2abfff1b23e8ffed9bd0f3a3e68/.github/workflows/ci.yml#L1-L20

setting the jvm to: graalvm:21

https://github.com/MasseGuillaume/porc-epic/runs/6169131815?check_suite_focus=true#step:4:21

output is

 openjdk version "1.8.0_292"
  OpenJDK Runtime Environment (build 1.8.0_292-b09)
  OpenJDK 64-Bit Server VM GraalVM CE 21.1.0 (build 25.292-b09-jvmci-21.1-b05, mixed mode)
  /opt/hostedtoolcache/cs/2.0.16/x64/cs java-home --jvm graalvm:21
  /home/runner/.cache/coursier/jvm/[email protected]

I'm expecting Java 17, am I missing something ?

Upgrade to node 16

Actions using Node 12 are considered deprecated and encouraged to upgrade to Node 16.
For reference: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

I wonder if all that is needed is just changing this line.

runs:
-  using: 'node12'
+  using: 'node16'
  main: 'dist/index.js'

And refreshing the package-lock.json using Node 16.

If so, I am more than happy to help.
But, if something else is required I would need assistance / guidance.

See also: coursier/cache-action#410

become verified in the GitHub Marketplace

Why coursier/setup-action Github Action is not certified by GitHub ?

could it help?
https://docs.github.com/en/developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization