👑setup-nim-action

This action sets up a Nim-lang👑 environment.

• v2 version was released 🎉
• Migration to v2 from v1
  • Q&A
    • getAppFilename failed
• 🔎Usage
  • Basic usage
  • Setup a latest patch version Nim
  • Setup a latest minor version Nim
  • Cache usage
  • Matrix testing usage
  • devel usage
  • Change Nim installation directory
  • Full example
• 🔨Development
• 📄License

v2 version was released 🎉

setup-nim-action has released v2 ( #491 ).

setup-nim-action v1 depended on choosenim. One day, an issue occurred that installation became very slow with choosenim ( #483 ). This process took between 6 and 20 minutes.

I changed setup-nim-action so that is does not use choosenim to solve this problem.

Migration to v2 from v1

1. Upgrade version of setup-nim-action to v2 from v1
2. Change cache key to clear cache if you are using it. The key can be anything if the cache will be cleared. Nothing to do if you are not using actions/cache
3. Remove caching choosenim if you are using it. setup-nim-action does not use choosenim now. Nothing to do if you are not caching choosenim
4. Remove yes and no-color parameters if you are using it. These parameters are not used now. Nothing to do if you are not these parameters

 steps:
   - uses: actions/checkout@v4

   - name: Cache nimble
     id: cache-nimble
     uses: actions/cache@v4
     with:
       path: ~/.nimble
-      key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
+      key: ${{ runner.os }}-nimble-v2-${{ hashFiles('*.nimble') }}
       restore-keys: |
-        ${{ runner.os }}-nimble-
+        ${{ runner.os }}-nimble-v2-
     if: runner.os != 'Windows'

-  - name: Cache choosenim
-    id: cache-choosenim
-    uses: actions/cache@v4
-    with:
-      path: ~/.choosenim
-      key: ${{ runner.os }}-choosenim-${{ matrix.cache-key }}-${{ steps.get-date.outputs.date }}
-      restore-keys: |
-        ${{ runner.os }}-choosenim-${{ matrix.cache-key }}-

-  - uses: jiro4989/setup-nim-action@v1
+  - uses: jiro4989/setup-nim-action@v2
     with:
       nim-version: '2.0.0' # default is 'stable'
+      repo-token: ${{ secrets.GITHUB_TOKEN }}
-      yes: false
-      no-color: yes
   - run: nimble build -Y
   - run: nimble test -Y

Q&A

getAppFilename failed

Please clear cache if you get the following error.

getAppFilename failed. (Error was: Unable to read /home/runner/.choosenim/current. (Error was: No installation has been chosen. (File missing: /home/runner/.choosenim/current)))

Cache is cleared if you change cache key.

     uses: actions/cache@v4
     with:
       path: ~/.nimble
-      key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
+      key: ${{ runner.os }}-nimble-v2-${{ hashFiles('*.nimble') }}
       restore-keys: |
-        ${{ runner.os }}-nimble-
+        ${{ runner.os }}-nimble-v2-
     if: runner.os != 'Windows'

Or please remove actions/cache.

-    uses: actions/cache@v4
-    with:
-      path: ~/.nimble
-      key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
-      restore-keys: |
-        ${{ runner.os }}-nimble-
-    if: runner.os != 'Windows'

🔎Usage

See action.yml

Basic usage

steps:
  - uses: actions/checkout@v4
  - uses: jiro4989/setup-nim-action@v2
    with:
      nim-version: '2.0.0' # default is 'stable'
      repo-token: ${{ secrets.GITHUB_TOKEN }}
  - run: nimble build -Y
  - run: nimble test -Y

repo-token is using for Rate limiting. It works without setting this parameter, but please set it if the following error message is returned.

Error: 403 - {"message":"API rate limit exceeded for nn.nn.nn.nnn. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)","documentation_url":"https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting"}

Setup a latest patch version Nim

Setup a latest patch version Nim when nim-version is 2.n.x .

steps:
  - uses: actions/checkout@v4
  - uses: jiro4989/setup-nim-action@v2
    with:
      nim-version: '2.0.x' # ex: 1.0.x, 1.2.x, 1.4.x, 2.0.x ...
      repo-token: ${{ secrets.GITHUB_TOKEN }}
  - run: nimble build -Y
  - run: nimble test -Y

Setup a latest minor version Nim

Setup a latest minor version Nim when nim-version is 2.x .

steps:
  - uses: actions/checkout@v4
  - uses: jiro4989/setup-nim-action@v2
    with:
      nim-version: '2.x'
      repo-token: ${{ secrets.GITHUB_TOKEN }}
  - run: nimble build -Y
  - run: nimble test -Y

Cache usage

steps:
  - uses: actions/checkout@v4
  - name: Cache nimble
    id: cache-nimble
    uses: actions/cache@v4
    with:
      path: ~/.nimble
      key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
      restore-keys: |
        ${{ runner.os }}-nimble-
    if: runner.os != 'Windows'
  - uses: jiro4989/setup-nim-action@v2
    with:
      repo-token: ${{ secrets.GITHUB_TOKEN }}
  - run: nimble build -Y
  - run: nimble test -Y

Matrix testing usage

If you want to support multiple Nim versions or multiple platforms, strategy.matrix is useful.

e.g. Tests multiple Nim versions:

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        nim:
          - '1.2.0'
          - '1.2.x'
          - '1.4.x'
          - '1.6.x'
          - '2.0.x'
          - 'stable'
          - 'devel'
    name: Nim ${{ matrix.nim }} sample
    steps:
      - uses: actions/checkout@v4
      - name: Setup nim
        uses: jiro4989/setup-nim-action@v2
        with:
          nim-version: ${{ matrix.nim }}
          repo-token: ${{ secrets.GITHUB_TOKEN }}
      - run: nimble build -Y
      - run: nimble test -Y

e.g. Tests multiple platforms:

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - windows-latest
          - macOS-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup nim
        uses: jiro4989/setup-nim-action@v2
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
      - run: nimble build -Y
      - run: nimble test -Y

e.g. Tests multiple Nim versions and platforms:

⚠️ WARN ⚠️ Depending on matrix count, the number of test jobs may be very large. It is recommend to keep the small matrix count.

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        nim:
          - '1.4.x'
          - '1.6.x'
          - '2.0.x'
          - 'stable'
        os:
          - ubuntu-latest
          - windows-latest
          - macOS-latest
    name: Nim ${{ matrix.nim }} sample
    steps:
      - uses: actions/checkout@v4
      - name: Setup nim
        uses: jiro4989/setup-nim-action@v2
        with:
          nim-version: ${{ matrix.nim }}
          repo-token: ${{ secrets.GITHUB_TOKEN }}
      - run: nimble build -Y
      - run: nimble test -Y

devel usage

Use devel version if you want to use devel compiler of Nim. setup-nim-action will fetch the devel source code and build the nim compiler every time.

jobs:
  test_devel:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Cache nimble
        id: cache-nimble
        uses: actions/cache@v4
        with:
          path: ~/.nimble
          key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
          restore-keys: |
            ${{ runner.os }}-nimble-

      - uses: jiro4989/setup-nim-action@v2
        with:
          nim-version: devel
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - run: nimble build -Y

But building the devel compiler takes a long time. If you don't want to build it every time, set use-nightlies to true.

jobs:
  test_devel:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Cache nimble
        id: cache-nimble
        uses: actions/cache@v4
        with:
          path: ~/.nimble
          key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }}
          restore-keys: |
            ${{ runner.os }}-nimble-

      - uses: jiro4989/setup-nim-action@v2
        with:
          nim-version: devel
          use-nightlies: true
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - run: nimble build -Y

Change Nim installation directory

setup-nim-action installs Nim to .nim_runtime directory of current directory. You can use parent-nim-install-directory and nim-install-directory parameters if you want to change it.

Use parent-nim-install-directory if you want to install nim to temporary directory. This example installs nim to /home/runner/work/_temp/.nim_runtime.

  - uses: jiro4989/setup-nim-action@v2
    with:
      nim-version: stable
      repo-token: ${{ secrets.GITHUB_TOKEN }}
      parent-nim-install-directory: ${{ runner.temp }}

Use nim-install-directory if you want to change base directory name. This example installs nim to $PWD/nim_compiler.

  - uses: jiro4989/setup-nim-action@v2
    with:
      nim-version: stable
      repo-token: ${{ secrets.GITHUB_TOKEN }}
      nim-install-directory: nim_compiler

Full example

See .github/workflows/test.yml.

🔨Development

This project uses shell script only. Run script/format.sh when you edited source code.

vim install_nim.sh
./script/format.sh

📄License

MIT