Integrations

Github Actions

Jarl can be used as a Github Action via setup-jarl. This action runs in a couple of seconds and will fail if there are any rule violations. It is possible to customize the arguments passed to Jarl in this action, such as the input paths.

Here is an example YAML file:

on:
  push:
    branches: main
  pull_request:

name: jarl-check

permissions: read-all

jobs:
  jarl-check:
    name: jarl-check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: etiennebacher/setup-jarl@v0.1.0

See the setup-jarl repository for more examples.

Container-based CI/CD platforms

jarl can also easily be run in open-source and lightweight CI solutions like Woodpecker CI or Crow CI. For container-based CI/CD, here is an example of using jarl within a slim alpine linux container image.

steps:
  - name: lint-r-jarl
    image: alpine:<YOUR_ALPINE_VERSION>
    commands: |
      apk add --no-cache -q curl
      curl -L -o jarl-installer.sh https://github.com/etiennebacher/jarl/releases/latest/download/jarl-installer.sh
      sh ./jarl-installer.sh
      source $HOME/.local/bin/env
      jarl check ./R/