A GitHub Action to run jarl.

This action is commonly used as a pass/fail test to ensure your repository stays clean, abiding the rules specified in your configuration. Though it runs jarl check by default, the action can do anything jarl can (ex, fix).

• Usage
  • Basic
  • Specify a different source directory
  • Specify multiple files
  • Use to install jarl
  • Install specific versions
    • Install the latest version (default)
    • Install a specific version
  • GitHub authentication token
• Outputs

- uses: etiennebacher/setup-jarl@v0.1.0

- uses: etiennebacher/setup-jarl@v0.1.0
  with:
    src: "./R"

- uses: etiennebacher/setup-jarl@v0.1.0
  with:
    src: >-
      path/to/file1.r
      path/to/file2.r

This action adds jarl to the PATH, so you can use it in subsequent steps.

- uses: etiennebacher/setup-jarl@v0.1.0
- run: jarl check --fix

By default, this action runs jarl check after installation. If you do not want to run any jarl command but only install it, you can use the args input to overwrite the default value (check):

- name: Install jarl without running check
  uses: etiennebacher/setup-jarl@v0.1.0
  with:
    args: "--version"

- name: Install the latest version of jarl
  uses: etiennebacher/setup-jarl@v0.1.0
  with:
    version: "latest"

- name: Install a specific version of jarl
  uses: etiennebacher/setup-jarl@v0.1.0
  with:
    version: "0.4.4"

This action uses the GitHub API to fetch the jarl release artifacts. To avoid hitting the GitHub API rate limit too quickly, an authentication token can be provided via the github-token input. By default, the GITHUB_TOKEN secret is used, which is automatically provided by GitHub Actions.

If the default permissions for the GitHub token are not sufficient, you can provide a custom GitHub token with the necessary permissions.

- name: Install the latest version of jarl with a custom GitHub token
  uses: etiennebacher/setup-jarl@v0.1.0
  with:
    github-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}