setup-julia/README.md

setup-julia Action

This action sets up a Julia environment for use in actions by downloading a specified version of Julia and adding it to PATH.

Table of Contents

• Table of Contents
• Usage
  • Inputs
  • Outputs
  • Basic
  • Julia Versions
  • Matrix Testing
  • versioninfo
• Versioning
• Debug logs
• Third party information

Usage

Inputs

- uses: julia-actions/setup-julia@v1
  with:
    # The Julia version that will be installed and added as `julia` to the PATH.
    # See "Julia Versions" below for a list of valid values.
    #
    # Warning: It is strongly recommended to wrap this value in quotes.
    #          Otherwise, the YAML parser used by GitHub Actions parses certain
    #          versions as numbers which causes the wrong version to be selected.
    #          For example, `1.0` may be parsed as `1`.
    #
    # Default: '1'
    version: ''

    # The architecture of the Julia binaries.
    #
    # Supported values: x64 | x86
    #
    # Default: x64
    arch: ''

    # If true, display the output of InteractiveUtils.versioninfo() after installing.
    # See "versioninfo" below for example usage.
    #
    # Default: false
    show-versioninfo: ''

Outputs

outputs:
  # Path to the directory containing the Julia executable.
  # Equivalent to JULIA_BINDIR: https://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_BINDIR
  #
  # Example output: '/opt/hostedtoolcache/julia/1.5.3/x64/bin'
  julia-bindir: ''

Basic

steps:
- uses: actions/checkout@v1.0.0
- uses: julia-actions/setup-julia@v1
  with:
    version: 1.0.4
- run: julia -e 'println("Hello, World!")'

Julia Versions

You can either specify specific Julia versions or version ranges. If you specify a version range, the highest available Julia version that matches the range will be selected.

Warning: It is strongly recommended to wrap versions in quotes. Otherwise, the YAML parser used by GitHub Actions parses certain versions as numbers which causes the wrong version to be selected. For example, 1.0 may be parsed as 1.

Examples

• 1.2.0 is a valid semver version. The action will try to download exactly this version. If it's not available, the build step will fail.
• 1.0 is a version range that will match the highest available Julia version that starts with 1.0, e.g. 1.0.5, excluding pre-releases.
• ^1.3.0-rc1 is a caret version range that includes pre-releases starting at rc1. It matches all versions ≥ 1.3.0-rc1 and < 2.0.0.
• ~1.3.0-rc1 is a tilde version range that includes pre-releases starting at rc1. It matches all versions ≥ 1.3.0-rc1 and < 1.4.0.
• ^1.3.0-0 is a caret version range that includes all pre-releases. It matches all versions ≥ 1.3.0- and < 2.0.0.
• ~1.3.0-0 is a tilde version range that includes all pre-releases. It matches all versions ≥ 1.3.0- and < 1.4.0.
• nightly will install the latest nightly build.

Internally the action uses node's semver package to resolve version ranges. Its documentation contains more details on the version range syntax. You can test what version will be selected for a given input in this JavaScript REPL.

The available Julia versions are pulled from versions.json. This file is automatically updated once a day. Therefore it may take up to 24 hours until a newly released Julia version is available in the action.

Matrix Testing

bash is chosen as shell to enforce consistent behaviour across operating systems. Other shells are available but you may have to escape quotation marks or otherwise adjust the syntax.

64-bit Julia only

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        julia-version: ['1.0', '1.2.0', '^1.3.0-rc1']
        os: [ubuntu-latest, windows-latest, macOS-latest]
    
    steps:
      - uses: actions/checkout@v1.0.0
      - name: "Set up Julia"
        uses: julia-actions/setup-julia@v1
        with:
          version: ${{ matrix.julia-version }}
      - run: julia -e 'println("Hello, World!")'
        shell: bash

32-bit Julia

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        julia-version: ['1.0', '1.2.0', '^1.3.0-rc1']
        julia-arch: [x64, x86]
        os: [ubuntu-latest, windows-latest, macOS-latest]
        # 32-bit Julia binaries are not available on macOS
        exclude:
          - os: macOS-latest
            julia-arch: x86
    
    steps:
      - uses: actions/checkout@v1.0.0
      - name: "Set up Julia"
        uses: julia-actions/setup-julia@v1
        with:
          version: ${{ matrix.julia-version }}
          arch: ${{ matrix.julia-arch }}
      - run: julia -e 'println("Hello, World!")'
        shell: bash

Alternatively, you can include specific version and OS combinations that will use 32-bit Julia:

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        julia-version: ['1.0', '1.2.0', '^1.3.0-rc1']
        os: [ubuntu-latest, windows-latest, macOS-latest]
        # Additionally create a job using 32-bit Julia 1.0.4 on windows-latest
        include:
          - os: windows-latest
            julia-version: ['1.0.4']
            julia-arch: x86
    
    steps:
      - uses: actions/checkout@v1.0.0
      - name: "Set up Julia"
        uses: julia-actions/setup-julia@v1
        with:
          version: ${{ matrix.julia-version }}
      - run: julia -e 'println("Hello, World!")'
        shell: bash

versioninfo

By default, only a brief version identifier is printed in the run log. You can display the full versioninfo by adding show-versioninfo. Here's an example that prints this information just for nightly:

    - uses: julia-actions/setup-julia@v1
      with:
        version: ${{ matrix.version }}
        arch: ${{ matrix.arch }}
        show-versioninfo: ${{ matrix.version == 'nightly' }}

You use 'true' if you want it printed for all Julia versions.

Versioning

This action follows GitHub's advice on versioning actions, with an additional latest tag.

If you don't want to deal with updating the version of the action, similiarly to how Travis CI handles it, use latest or major version branches. Dependabot can also be used to automatically create Pull Requests to update actions used in your workflows.

It's unlikely, but not impossible, that there will be breaking changes post-v1.0.0 unless a new major version of Julia is introduced.

You can specify commits, branches or tags in your workflows as follows:

steps:
  - uses: julia-actions/setup-julia@d3ce119a16594ea9e5d7974813970c73b6ab9e94 # commit SHA of the tagged 1.4.1 commit
  - uses: julia-actions/setup-julia@latest  # latest version tag (may break existing workflows)
  - uses: julia-actions/setup-julia@v1      # major version tag
  - uses: julia-actions/setup-julia@v1.4    # minor version tag
  - uses: julia-actions/setup-julia@v1.4.1  # specific version tag

If your workflow requires access to secrets, you should always pin it to a commit SHA instead of a tag. This will protect you in case a bad actor gains access to the setup-julia repo. You can find more information in GitHub's security hardening guide.

Debug logs

You can enable Step Debug Logs for more detailed logs. Note that when debug logs are enabled, a request will be sent to https://httpbin.julialang.org/ip and the runner's IP will be printed to the debug logs.

Third party information

Parts of this software have been derived from other open source software. See THIRD_PARTY_NOTICE.md for details.