install-nim

install-nim copied to clipboard

Github Action to install Nim.

Put the following in .github/workflows/tests.yml

Fastest, complete example:

on:
  pull_request:
  push:

jobs:
  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        nimversion:
          - binary:stable
        os:
          - ubuntu-latest
          - macOS-13
          - windows-latest
    steps:
    - uses: actions/checkout@v1
    - uses: iffy/install-nim@v5
      with:
        version: ${{ matrix.nimversion }}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Test
      run: |
        nimble install -y
        nimble test

Use latest stable Nim version

on:
  pull_request:
  push:

jobs:
  default:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: iffy/install-nim@v5
      - run: nimble install -y
      - run: nimble test

Use specific Nim versions

on:
  pull_request:
  push:

jobs:
  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        version:
          - binary:stable
          - devel
          - 1.4.0
          - 1.2.8
          - 1.0.10
          - git:bbe49a14ae827b6474d692042406716a3b3dd71f
          - binary:1.6.0
        os:
          - ubuntu-latest
          - macOS-13
          - windows-latest
    steps:
    - uses: actions/checkout@v1
    - uses: iffy/install-nim@v5
      with:
        version: ${{ matrix.version }}
    - name: Test
      continue-on-error: ${{ matrix.version == 'devel' }}
      run: |
        nimble install -y
        nimble test

If you run into trouble with GitHub rate limits, set the GITHUB_TOKEN environment variable like this:

jobs:
  tests:
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    # etc...

Speed

If available, the fastest way to install is with the binary: tag (e.g. binary:1.4.0 or binary:stable). See nightlies.txt for a list of available versions.

Implementation

By default, this action uses choosenim to install Nim.

You can also explicitly request a particular build method by prefixing the version with a tag (e.g. git: as above). See .github/workflows/main.yml for examples.

Alternatives

These other GitHub actions might suit your needs better (they're worth checking out):

• https://github.com/alaviss/setup-nim
• https://github.com/jiro4989/setup-nim-action