setup-clojure/README.md

98 lines
3.1 KiB
Markdown
Raw Normal View History

# setup-clojure
This action sets up Clojure tools environment for using in GitHub Actions.
2022-07-18 12:00:22 +02:00
* [Clojure CLI](https://clojure.org/guides/deps_and_cli)
* [leiningen](https://leiningen.org/)
* [boot-clj](https://boot-clj.github.io/)
* [babashka](https://babashka.org/)
* [clj-kondo](https://github.com/clj-kondo/clj-kondo)
* [cljstyle](https://github.com/greglook/cljstyle)
* [deps.clj](https://github.com/borkdude/deps.clj)
* [zprint](https://github.com/kkinnear/zprint)
2022-07-20 15:19:23 +02:00
All three major tools (Clojure CLI, leiningen and boot-clj) available for MacOS, Ubuntu and Windows based runners. Please look at [Smoke Test Workflow file](https://github.com/DeLaGuardo/setup-clojure/blob/main/.github/workflows/smoke-tests.yml) for compatibility matrix.
2020-09-21 10:32:50 +02:00
# Usage
Here is a snippet for your workflow file:
```yaml
2021-03-24 17:57:52 +01:00
name: Example workflow
on: [push]
jobs:
clojure:
strategy:
matrix:
os: [ubuntu-latest, macOS-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
2021-03-24 17:57:52 +01:00
2022-07-18 12:00:22 +02:00
# It is important to install java before installing clojure tools which needs java
# exclusions: babashka, clj-kondo and cljstyle
2021-03-24 17:57:52 +01:00
- name: Prepare java
uses: actions/setup-java@v3
2021-03-24 17:57:52 +01:00
with:
2021-08-06 10:37:54 +02:00
distribution: 'zulu'
java-version: '8'
2021-03-24 17:57:52 +01:00
- name: Install clojure tools
uses: DeLaGuardo/setup-clojure@9.1
2021-03-24 17:57:52 +01:00
with:
# Install just one or all simultaneously
# The value must indicate a particular version of the tool, or use 'latest'
# to always provision the latest version
2022-07-18 12:00:22 +02:00
cli: 1.10.1.693 # Clojure CLI based on tools.deps
lein: 2.9.1 # Leiningen
boot: 2.8.3 # Boot.clj
bb: 0.7.8 # Babashka
clj-kondo: 2022.05.31 # Clj-kondo
cljstyle: 0.15.0 # cljstyle
cmd-exe-workaround: 'latest' # Replaces `clojure` with `deps.clj` on Windows
zprint: 1.2.3 # zprint
2021-03-24 17:57:52 +01:00
- name: Execute clojure code on Linux and MacOS
if: ${{ matrix.os != 'windows-latest' }}
run: clojure -e "(+ 1 1)"
shell: bash
- name: Execute clojure code on Windows
if: ${{ matrix.os == 'windows-latest' }}
run: clojure -e "(+ 1 1)"
shell: powershell
- name: Get leiningen version
run: lein -v
- name: Get boot version
run: boot -V
2022-06-16 16:57:17 +05:00
- name: Get babashka version
run: bb --version
- name: Get clj-kondo version
run: clj-kondo --version
- name: Get cljstyle version
# cljstyle is not yet available for windows
if: ${{ matrix.os != 'windows-latest' }}
run: cljstyle version
2022-06-27 19:23:56 +03:00
- name: Get zprint version
run: zprint --version
```
2022-07-20 15:19:23 +02:00
For more application cases please check [Smoke Test Workflow file](https://github.com/DeLaGuardo/setup-clojure/blob/main/.github/workflows/smoke-tests.yml)
2019-10-08 12:46:58 +02:00
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)