https://github.com/coursier/setup-action

▶️ GitHub Action using Coursier to install JVM and Scala tools
https://github.com/coursier/setup-action

coursier coursier-setup github-actions jvm scala setup-scala

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/coursier/setup-action
• Owner: coursier
• License: mit
• Created: 2020-10-26T00:45:10.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T13:10:16.000Z (10 days ago)
• Last Synced: 2024-11-04T15:05:11.459Z (10 days ago)
• Topics: coursier, coursier-setup, github-actions, jvm, scala, setup-scala
• Language: TypeScript
• Homepage:
• Size: 3.48 MB
• Stars: 54
• Watchers: 7
• Forks: 23
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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](https://github.com/olafurpg/setup-scala) and the blog post [Single command Scala setup](https://alexarchambault.github.io/posts/2020-09-21-cs-setup.html) by Alex Archambault (author of Coursier).

## Features

- run it on any platform: Linux, MacOS, Windows

- install [any JVM](https://get-coursier.io/docs/cli-java.html#jvm-index) you need

- setup the build tool of your choice: sbt, mill, seed, etc.

- install other common Scala CLI tools: Ammonite, Bloop, giter8, [etc.](https://github.com/coursier/apps/tree/master/apps/resources)

## 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](https://github.com/coursier/apps))

- `customRepositories` (optional): ''

  - Pipe separated list of [repositories](https://get-coursier.io/docs/other-repositories) to supply to coursier

- `disableDefaultRepos` (optional): 'false'

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

### Example with custom inputs

```yml

  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](https://github.com/coursier/cache-action). For example:

```yml

  steps:

    - uses: actions/checkout@v2

    - uses: coursier/cache-action@v6

    - uses: coursier/setup-action@v1

```