Update docs

Input variable `dynamic-space-size` was added. It can be used to default set memory size for SBCL.

.github/workflows/docs.yml

@@ -117,18 +117,18 @@
           "if": "steps.cache.outputs.cache-hit != 'true'"
         },
         {
-          "name": "Change dist to Ultralisp",
-          "run": "echo 'dist ultralisp http://dist.ultralisp.org' > qlfile",
+          "name": "Change dist to Ultralisp if qlfile does not exist",
+          "run": "if [[ ! -e qlfile ]]; then echo 'dist ultralisp http://dist.ultralisp.org' > qlfile; fi",
           "shell": "bash"
         },
         {
           "name": "Update Qlot",
-          "run": "qlot update || qlot update",
+          "run": "qlot update --no-deps",
           "shell": "bash"
         },
         {
           "name": "Install SBLint wrapper",
-          "run": "qlot exec ros install 40ants-linter",
+          "run": "qlot exec ros install 40ants-asdf-system 40ants-linter",
           "shell": "bash"
         },
         {

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+{
+  "name": "RELEASE",
+  "on": {
+    "push": {
+      "branches": [
+        "master"
+      ]
+    }
+  },
+  "jobs": {
+    "autotag": {
+      "permissions": {
+        "contents": "write"
+      },
+      "runs-on": "ubuntu-latest",
+      "env": {
+        "OS": "ubuntu-latest"
+      },
+      "steps": [
+        {
+          "name": "Checkout Code",
+          "uses": "actions/checkout@v3"
+        },
+        {
+          "name": "Create release tag",
+          "uses": "butlerlogic/action-autotag@8bc1ad456dcdee34e8c6ffbce991cc31793578c2",
+          "with": {
+            "root": "ChangeLog.md",
+            "regex_pattern": "^## (?<version>\\d+\\.\\d+\\.\\d+.*?)( |\\n).*$",
+            "tag_prefix": "v"
+          },
+          "env": {
+            "GITHUB_TOKEN": "${{ secrets.GITHUB_TOKEN }}"
+          }
+        }
+      ]
+    }
+  }
+}

.github/workflows/tests.yml

@@ -2,40 +2,133 @@ name: tests
 
 on:
   push:
+    branches:
+      - master
   pull_request:
   schedule:
     - cron: "0 0 * * SUN"
 
 jobs:
   tests:
-    # We want to run on external PRs, but not on our own internal PRs as
-    # they'll be run by the push to the branch.
-    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       fail-fast: false # Let the workflow continue as much as possible
       matrix:
         include:
+          # Linux
+          - os: ubuntu-latest
+            lisp: abcl-bin
+          # See issue: https://github.com/40ants/setup-lisp/issues/22
+          # - os: ubuntu-latest
+          #   lisp: allegro
+          - os: ubuntu-latest
+            lisp: ccl-bin
+          # See issue: https://github.com/40ants/setup-lisp/issues/16
+          # - os: ubuntu-latest
+          #   lisp: clasp
+          - os: ubuntu-latest
+            lisp: clasp-bin
+          # See issue: https://github.com/40ants/setup-lisp/issues/15
+          # - os: ubuntu-latest
+          #   lisp: clisp
+          - os: ubuntu-latest
+            lisp: clisp-head
+          - os: ubuntu-latest
+            lisp: cmu-bin
+          - os: ubuntu-latest
+            lisp: ecl
+          # See issue: https://github.com/40ants/setup-lisp/issues/17
+          # - os: ubuntu-latest
+          #   lisp: mkcl
+          # See issue: https://github.com/40ants/setup-lisp/issues/18
+          # - os: ubuntu-latest
+          #   lisp: npt
+          - os: ubuntu-latest
+            lisp: sbcl
+          # Just to ensure test.ros will not fail when version
+          # is specified explicitly
+          - os: ubuntu-latest
+            lisp: sbcl/2.3.1
           - os: ubuntu-latest
             lisp: sbcl-bin
-          - os: macos-latest
+
+          # OSX
+          - os: macos-13
+            lisp: abcl-bin
+          - os: macos-13
+            lisp: ccl-bin
+          # https://github.com/40ants/setup-lisp/issues/29
+          # - os: macos-13
+          #   lisp: clasp-bin
+          # https://github.com/40ants/setup-lisp/issues/28
+          # - os: macos-13
+          #   lisp: clisp-head
+          # https://github.com/40ants/setup-lisp/issues/30
+          # - os: macos-13
+          #   lisp: cmu-bin
+          - os: macos-13
+            lisp: ecl
+          - os: macos-13
             lisp: sbcl-bin
+
+          - os: macos-14
+            lisp: abcl-bin
+          # - os: macos-14
+          #   lisp: ccl-bin
+          # https://github.com/40ants/setup-lisp/issues/29
+          # - os: macos-14
+          #   lisp: clasp-bin
+          # https://github.com/40ants/setup-lisp/issues/28
+          # - os: macos-14
+          #   lisp: clisp-head
+          # https://github.com/40ants/setup-lisp/issues/30
+          # - os: macos-14
+          #   lisp: cmu-bin
+          - os: macos-14
+            lisp: ecl
+          - os: macos-14
+            lisp: sbcl-bin
+
+
+          # Windows
+
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: abcl-bin
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: ccl-bin
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: clasp-bin
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: clisp-head
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: cmu-bin
+          # https://github.com/40ants/setup-lisp/issues/27
+          # - os: windows-latest
+          #   lisp: ecl
           - os: windows-latest
             lisp: sbcl-bin
+            
+
     defaults:
       run:
-        shell: lispsh {0}
+        shell: lispsh -eo pipefail {0}
     env:
       LISP: ${{ matrix.lisp }}
     name: test with ${{ matrix.lisp }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           # The repo already contains the qlot and qlot.lock files, and since
           # we don't want those to interfere with the current test run, we
           # clone the repository somewhere else (i.e. something different from
           # the default './')
-          path: setup-lisp/
+          path: setup-lisp
       - name: Call setup-lisp with default arguments
         if: github.event_name != 'schedule'
         uses: ./setup-lisp/
@@ -50,4 +143,10 @@ jobs:
           asdf-version: 3.3.5.3
           qlot-version: latest
       - run: ros config
-      - run: qlot exec ros install 40ants/gh-pages
+        # On OSX this steps fails often:
+        # https://github.com/40ants/setup-lisp/issues/31
+        # I don't know how to fix it, so we'll skip it for now:
+        continue-on-error: true
+      - run: qlot exec ros install 40ants/cl-info
+      - run: qlot exec cl-info
+

.gitignore

@@ -2,3 +2,4 @@
 /env/
 /.qlot
 /README
+*.fasl

ChangeLog.md

@@ -2,6 +2,151 @@
 
 # ChangeLog
 
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E2-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.2.1 (2024-12-15)
+
+Fixed the way how we set dynamic-space-size.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.2.0 (2024-12-14)
+
+Input variable `dynamic-space-size` was added. It can be used to default set memory size for `SBCL`.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.1.0 (2024-05-17)
+
+<a id="added"></a>
+
+### Added
+
+* Input argument qlot-no-deps was added.
+
+Make Qlot ignore asd files and their dependencies.
+
+This this might be useful in rare cases when your project contains a non-readable asd files such as templates.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E5-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.5 (2024-04-19)
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Extended test matrix with macos-14 runner.
+* Fixed Roswell cache paths for macos-14 runner.
+* Extended qlot cache key with runner architecture.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E4-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.4 (2024-04-18)
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Cache key was extended with runner architecture. Thanks for the contribution to Ákos Kiss!
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E3-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.3 (2024-03-12)
+
+<a id="fixed"></a>
+
+### Fixed
+
+* There was an error when action suceeded, but actually failed trying to load my quicklisp fix for package inferred systems.
+  A code to load this fix used `:HOME` as a pathname component which is not supported by some `CL` implementations. Actually,
+  I've already fixed this issue in 3.1.0 version, but somehow this fix was lost. Also, a handler-bind wrapper around the loader was added
+  and now action's tests will fail in case of any errors.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E2-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.2 (2024-02-27)
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Fix recreating of qlfile inside qlot environment cache.
+
+When some jobs used qlfile-template argument + caching, a template application
+  result was cached and caused an error during the next run.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.1 (2024-02-25)
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Fixed loading of quicklisp-osx-fix. Previously the script made unnecessary output and when you had a `qlfile` template in your workflow this output leaked into `qlfile` broking following `qlot install`.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C4-2E0-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 4.0.0 (2024-02-24)
+
+<a id="changed"></a>
+
+### Changed
+
+* Internal cache mechanism was added. Now action caches Roswell and Qlot files to speed up reruns. For example, without cache action could be executed about 4 minutes, and with cache it runs only 20 seconds on Ubuntu or 1 minute on Windows.
+* A new input variable `cache` was added to control caching beheviour. It is `true` by default, but you can switch it to `false` to turn caching off.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C3-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 3.2.0 (2024-01-30)
+
+<a id="changed"></a>
+
+### Changed
+
+* Now action uses `bash -xeo pipefail` for running Roswell install script. This way, in case of some errors inside the script, it will be interrupted immediately.
+* Also, we don't attempt to set `ROSWELL_INSTALL_DIR` env variable anymore, because despite it's presence, Roswell was installed into `/mingw64/bin/` instead under Windows and it works well (at least for me).
+* Now we don't add action's directory to the `PATH` using modification of `GITHUB_PATH` variable. This prevents modification of the `PATH` of a workflow called the action.
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Fixed running of test.ros script under Windows.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C3-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 3.1.0 (2024-01-27)
+
+<a id="changed"></a>
+
+### Changed
+
+* Switched from Roswell v21.10.14.111 to v23.10.14.114.
+* Now action checks if it is really installed requested Lisp implementation.
+* A list of supported implementation was added to the documentation.
+* Some implementation supported by Roswell, have problems. If you need them, please, contribute the fix either to this action or to the Roswell itself.
+
+<a id="fixed"></a>
+
+### Fixed
+
+* Now all steps fail-fast on the first encountered error. Previously some step might be failed, but action's execution was considered success.
+* Fixed Quicklisp fix activation for lisp implementations which are not support `:HOME` as part of the pathname.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C3-2E0-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 3.0.0 (2023-12-14)
+
+Now action uses a fix for Quicklisp client which makes it possible to load package inferred `ASDF` systems by name of the subsystem.
+
+<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C2-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## 2.1.0 (2022-11-10)
+
+Moved to newer action msys2/setup-msys2@2.14.2 where a warning about stale Node.js version is fixed.
+
 <a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C2-2E0-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
 
 ## 2.0.0 (2021-10-28)
@@ -25,9 +170,7 @@ If you want latest version, pass "latest" as value of
 Currently these versions are used:
 
 * `ASDF`: 3.3.5.3
-
 * Roswell: v21.10.14.111
-
 * Qlot: 0.11.5
 
 Thanks for these changes to Matteo Landi!

README.md

@@ -15,18 +15,45 @@ and [Qlot][e3ea] inside the Github `CI`.
 
 * It installs Roswell and all it's dependencies, doing right thing depending on
   the operating system. It should work on Ubuntu, `OSX` and Windows.
-
 * Upgrade `ASDF` to the latest version.
-
 * Installs Qlot.
-
 * Adds to `PATH` these directories: `~/.roswell/bin` and `.qlot/bin`
-
 * Creates `.qlot` by running `qlot install`. How to override content of the
   `qlfile`, see "Overriding qlfile" section.
-
 * And finally, it can install a specified `ASDF` system and all it's dependencies.
   But this step is optional.
+* Installed Roswell, `.qlot` and `~/.cache/common-lisp/` files are cached to speed up
+  repeated builds.
+
+<a id="x-28PROJECT-DOCS-3A-3A-40IMPLEMENTATION-SUPPORT-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
+
+## Implementation support
+
+Most implementations are tested on Linux, but for some of them Windows and `OSX` are also should work.
+
+Note, that for correct execution, your workflow should use `lispsh -eo pipefail` instead of default `bash`.
+This way a workflow will work Linux, `OSX` and Windows. You you will ignore this advice, you'll see such error
+when trying to call `ros` or `qlot` scripts:
+
+```
+/c/Users/runneradmin/.roswell/lisp/quicklisp/bin/qlot: line 4: exec: ros: not found
+  Error: Process completed with exit code 127.
+```
+| **Implementation** | **Linux** | **OSX** | **Windows** |
+| --- | --- | --- | --- |
+| abcl-bin | ✅ | ✅ | [❌][d780] |
+| allegro | [❌][d984] |  |  |
+| ccl-bin | ✅ | ✅ | [❌][d780] |
+| clasp | [❌][ecc6] |  | [❌][d780] |
+| clasp-bin | ✅ | [❌][bf3c] |
+| clisp | [❌][78c5] |  | [❌][d780] |
+| clisp-head | ✅ | [❌][5334] |
+| cmu-bin | ✅ | [❌][2599] | [❌][d780] |
+| ecl | ✅ | ✅ | [❌][d780] |
+| mkcl | [❌][2801] |  |  |
+| npt | [❌][7189] |  |  |
+| sbcl | ✅ |  |  |
+| sbcl-bin | ✅ | ✅ | ✅ |
 
 <a id="x-28PROJECT-DOCS-3A-3A-40TYPICAL-USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
 
@@ -58,8 +85,8 @@ jobs:
       LISP: ${{ matrix.lisp }}
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: 40ants/setup-lisp@v2
+      - uses: actions/checkout@v4
+      - uses: 40ants/setup-lisp@v4
         with:
           asdf-system: cl-info
       - uses: 40ants/run-tests@v2
@@ -69,7 +96,7 @@ jobs:
 The part, corresponding to an action call is:
 
 ```yaml
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     asdf-system: cl-info
 ```
@@ -96,7 +123,7 @@ working with this action. However, should you need to use a different version
 instead, you can specify that via the `roswell-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     roswell-version: v21.10.14.111
 ```
@@ -109,7 +136,7 @@ working with this action.  However, should you need to use a different version
 instead, you can specify that via the `asdf-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     asdf-version: 3.3.5.3
 ```
@@ -122,7 +149,7 @@ working with this action.  However, should you need to use a different version
 instead, you can specify that via the `qlot-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     qlot-version: 0.11.5
 ```
@@ -157,8 +184,8 @@ env:
   QUICKLISP_DIST: ${{ matrix.quicklisp-dist }}
 
 steps:
-  - uses: actions/checkout@v2
-  - uses: 40ants/setup-lisp@v2
+  - uses: actions/checkout@v4
+  - uses: 40ants/setup-lisp@v4
     with:
       asdf-system: cl-info
       qlfile-template: |
@@ -170,9 +197,7 @@ Here we see a few important things.
 
 1. We put into the env var the type of the quicklisp distribution we want to
    our library to test against.
-
 2. We pass a multiline argument `qlfile-template` to the action.
-
 3. Template refers to `quicklisp_dist` to conditionally include a line
    into `qlfile` when `quicklisp_dist == "ultralisp"`.
 
@@ -189,65 +214,23 @@ Usually installing Roswell, a lisp implementation and dependencies
 take from 2 to 10 minutes. Multiply this to the number of
 matrix combinations and you'll get signifficant time.
 
-To speed up build, you can use caching using a standad GitHub action `actions/cache@v2`.
+Starting from version `4.0.0`, this action cares about caching itself
+and you don't need to wrap it with `actions/cache`. This behaviour
+of enabled by default. Without cache action could be executed about
+4 minutes, and with cache it runs only 20 seconds on Ubuntu or 1 minute on Windows.
 
-To make caching work, add such sections into your workflow file:
+A new input variable `cache` was added to control caching beheviour.
+It is `true` by default, but you can switch it to `false` to turn caching off.
 
-```yaml
-- name: Grant All Perms to Make Cache Restoring Possible
-  run: |
-    sudo mkdir -p /usr/local/etc/roswell
-    sudo chown "${USER}" /usr/local/etc/roswell
-    # Here the ros binary will be restored:
-    sudo chown "${USER}" /usr/local/bin
-- name: Get Current Month
-  id: current-month
-  run: |
-    echo "::set-output name=value::$(date -u "+%Y-%m")"
-- name: Cache Roswell Setup
-  id: cache
-  uses: actions/cache@v2
-  env:
-    cache-name: cache-roswell
-  with:
-    path: |
-      /usr/local/bin/ros
-      ~/.cache/common-lisp/
-      ~/.roswell
-      /usr/local/etc/roswell
-      .qlot
-    key: "${{ steps.current-month.outputs.value }}-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles('qlfile.lock') }}"
-- name: Restore Path To Cached Files
-  run: |
-    echo $HOME/.roswell/bin >> $GITHUB_PATH
-    echo .qlot/bin >> $GITHUB_PATH
-  if: steps.cache.outputs.cache-hit == 'true'
-- uses: 40ants/setup-lisp@v2
-  if: steps.cache.outputs.cache-hit != 'true'
-```
-There are two important lines here.
-
-* The last line `if: steps.cache.outputs.cache-hit != 'true'` skips
-  running lisp installation, it it was take from the cache.
-
-* The `key` value:
-
-`
-  key: "${{ steps.current-month.outputs.value }}-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles('qlfile.lock') }}"
-`
-
-It controls when your cache will be matched. If you are using `matrix`, put all it's components
-  into the key.
-
-I also added a current month there, to make sure cache will be renewed at least monthly.
-  This way a new Roswell, Qlot and `ASDF` will be used in a build.
+The current month is used as part of the cache key, to refresh caches every month.
+This way a new Roswell, Qlot and `ASDF` will be used in a build. Also, you can set
+`env.cache-name` variable to some value, to force rebuild with a fresh cache.
 
 <a id="x-28PROJECT-DOCS-3A-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
 
 ## Roadmap
 
 * Support [CLPM][2c45].
-
 * Vendor all dependencies, to make action more reliable and secure.
 
 <a id="x-28PROJECT-DOCS-3A-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
@@ -262,6 +245,15 @@ If you want to contribute to this system, join development at GitHub:
 [8469]: https://40ants.com/run-tests
 [04b3]: https://docs.djangoproject.com/en/3.1/topics/templates/
 [cbff]: https://github.com/40ants/setup-lisp
+[78c5]: https://github.com/40ants/setup-lisp/issues/15
+[ecc6]: https://github.com/40ants/setup-lisp/issues/16
+[2801]: https://github.com/40ants/setup-lisp/issues/17
+[7189]: https://github.com/40ants/setup-lisp/issues/18
+[d984]: https://github.com/40ants/setup-lisp/issues/22
+[d780]: https://github.com/40ants/setup-lisp/issues/27
+[5334]: https://github.com/40ants/setup-lisp/issues/28
+[bf3c]: https://github.com/40ants/setup-lisp/issues/29
+[2599]: https://github.com/40ants/setup-lisp/issues/30
 [e3ea]: https://github.com/fukamachi/qlot
 [3dbd]: https://github.com/mmontone/djula
 [795a]: https://github.com/roswell/roswell

action.yml

@@ -1,47 +1,118 @@
 name: 'Setup Common Lisp'
+author: Alexander Artemenko
+description: This action setup Roswell and a Common Lisp implementation plus Qlot for managing virtual environments.
 
 inputs:
   roswell-version:
     description: 'Roswell version to install. If not specified, the latest working version will be used; if "latest", the latest version is used'
     required: false
-    default: v21.10.14.111
+    default: v23.10.14.114
+
+  dynamic-space-size:
+    description: 'If given, then will be used to change dynamic space size for SBCL. This value will be written to ~/.roswell/config'
+    required: false
+
   asdf-system:
     description: 'ASDF system to install'
     required: false
+
   asdf-version:
     description: 'ASDF version to install. If not specified, the latest working version will be used; if "latest", the latest version is used'
     required: false
     default: 3.3.5.3
+
   qlot-version:
     description: 'Qlot version to install. If not specified, the latest working version will be used; if "latest", the latest version is used'
     required: false
     default: 0.11.5
+
+  qlot-no-deps:
+    description: 'Make Qlot ignore asd files and their dependencies. This this might be useful in rare cases when your project contains a non-readable asd files such as templates.'
+    required: false
+    default: false
+
   qlfile-template:
     description: "Djula template for qlfile. All environment variables are available in it's context"
     required: false
 
+  cache:
+    description: 'If true (default), then cache will be created to speedup repeated action runs.'
+    required: false
+    default: true
+
+  # GitHub does not support anchors in the action
+  # and returns error like this:
+  #
+  # Anchors are not currently supported. Remove the anchor 'roswell-cache-paths'
+  #
+  # That is why I use "input" variable to not repeat this list in two places
+  roswell-cache-paths:
+    description: "Internal var. Don't use it."
+    required: false
+    default: |
+      ~/.quicklisp-client-fix
+      ~/.roswell
+      /usr/local/etc/roswell
+      /usr/local/bin/ros
+      /usr/local/Cellar/roswell
+      /opt/homebrew/bin/ros
+      /opt/homebrew/Cellar/roswell
+
+  qlot-cache-paths:
+    description: "Internal var. Don't use it."
+    required: false
+    default: |
+      path: |
+        qlfile
+        qlfile.lock
+        ~/.cache/common-lisp/
+        .qlot
+
+  cache-suffix:
+    description: "Internal var. Don't use it."
+    required: false
+    default: v9
+
 runs:
   using: composite
   steps:
-    # Using branch v2.14.0
-    - uses: msys2/setup-msys2@d40200dc2db4c351366b048a9565ad82919e1c24
+    - name: Calculate variables
+      id: locals
+      shell: bash
+      run: |
+        if [[ '${{ inputs.roswell-version }}' == 'latest' ]]
+        then
+          echo "windows-package-name=mingw-w64-x86_64-roswell" >> $GITHUB_OUTPUT
+        else
+          # Strip v prefix from version number
+          ROS_VERSION=$(echo ${{ inputs.roswell-version }} | sed 's/v//')
+          echo "windows-package-name=mingw-w64-x86_64-roswell=$ROS_VERSION" >> $GITHUB_OUTPUT
+        fi
+
+        # echo 'roswell-cache-paths=~/.quicklisp-client-fix\n~/.roswell\n/usr/local/etc/roswell\n/usr/local/bin/ros\n/usr/local/Cellar/roswell' >> $GITHUB_OUTPUT
+
+        echo "current-month=$(date -u '+%Y-%m')" >> $GITHUB_OUTPUT
+            
+    - if: runner.os == 'Windows'
+      uses: msys2/setup-msys2@cc11e9188b693c2b100158c3322424c4cc1dadea #v2.22.0
       with:
-        # Roswell was added to msys2 just _recently_, so the following makes
-        # sure packages metadata is up to date.  Otherwise...
-        #
-        #    $ pacman -S mingw-w64-x86_64-roswell
-        #    error: target not found: mingw-w64-x86_64-roswell
-        #    Error: Process completed with exit code 1
-        update: true
         # Msys2 has its own PATH, and the following setting enables standard
         # PATH manipulation expressions like the one shown below, to succeed:
         #
         #    $ echo /usr/local/bin >> $GITHUB_PATH
         path-type: inherit
         platform-check-severity: warn
+        # Installing ASDF requires `make`, so let's make sure it's
+        # available
+        install: >-
+          make
+          ${{ steps.locals.outputs.windows-package-name }}
+        cache: ${{ inputs.cache }}
+
     - name: Create lispsh
       shell: bash
       run: |
+        echo ::group::Set up link to lispsh
         # All the steps below, should work without problems on Linux, Mac OS,
         # and Windows, provided that they are run with the "right" shell
         # parameter, i.e. bash for Linux and Mac OS, and msys2 for Windows.
@@ -52,53 +123,29 @@ runs:
         # workaround I came up with is:
         #
         # 1. Symlink bash/msys2 to a known location, i.e. lispsh
-        # 2. Use lispsh as shell parameter
+        # 2. Use lispsh -eo pipefail {0} as shell parameter
+        #
+        # Pay attention to -eo pipefail options. We need them to exit on the
+        # first error. Without this option, Roswell might fail to install the
+        # implementation and continue to execute everything with default SBCL.
         #
         # It's not ideal, but the alternative is to duplicate most of the steps
         # below, and have some of them with `shell: bash`, and others with
         # `shell: msys2 {0}`.
         if [[ "$RUNNER_OS" == "Windows" ]]; then
-            powershell New-Item -ItemType SymbolicLink \
+            powershell New-Item -ItemType SymbolicLink -Force \
               -Path  "D:/a/_temp/setup-msys2/lispsh.cmd" \
               -Target "D:/a/_temp/setup-msys2/msys2.cmd"
         else
             sudo ln -sf $(which bash) /usr/local/bin/lispsh
         fi
+        echo ::endgroup::
     - name: Set up Environment
       shell: bash
       run: |
         echo ::group::Set up Environment
-        if [[ "$RUNNER_OS" == "Windows" ]]; then
-            # ROSWELL_INSTALL_DIR defaults to /usr/local/bin which
-            # unfortunately is not part of PATH on Windows; one could be
-            # tempted to patch things up like this:
-            #
-            #     echo /usr/local/bin >> $GITHUB_PATH
-            #
-            # However, if the absolute Windows path that /usr/local/bin
-            # actually refers to, contains any white space in it, you will
-            # inevitably bump into the following error:
-            #
-            #     'C:\Program' is not recognized as an internal or external command,
-            #       operable program or batch file.
-            #       Install Script for sbcl-bin...
-            #       'C:\Program' is not recognized as an internal or external command,
-            #       operable program or batch file.
-            #       Unhandled UIOP/RUN-PROGRAM:SUBPROCESS-ERROR in thread #<SB-THREAD:THREAD "main thread" RUNNING
-            #                                                                {10057000A3}>:
-            #         Subprocess #<UIOP/LAUNCH-PROGRAM::PROCESS-INFO {100506B0E3}>
-            #        with command "C:\\Program Files\\Git\\usr\\local\\bin\\ros.exe config set setup.time 3843610170"
-            #        exited with error code 1
-            #
-            #       Backtrace for: #<SB-THREAD:THREAD "main thread" RUNNING {10057000A3}>
-            #
-            # The work-around?  Install Roswell in a different location, whose
-            # absolute path we are 100% positive won't contain any white
-            # spaces!
-            mkdir -p /d/a/_temp/roswell
-            echo ROSWELL_INSTALL_DIR=/d/a/_temp/roswell >> $GITHUB_ENV
-            echo /d/a/_temp/roswell >> $GITHUB_PATH
 
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
             # Roswell internally checks for the MSYSCON env varible to be
             # defined, and when not there, it would go and install msys2 (i.e.
             # `ros install msys2+`) and rely on the `bash` bonary that comes
@@ -144,20 +191,60 @@ runs:
         fi
         echo $HOME/.roswell/bin >> $GITHUB_PATH
         echo ::endgroup::
-    - name: Current Env
-      shell: bash
-      run: |
-        echo ::group::Environment
-        echo "Current dir:"
-        pwd
 
-        echo "Environment Variables:"
-        env | sort -u
-        echo ::endgroup::
-    - name: Install Roswell
-      shell: lispsh {0}
+    # TODO: comment for prod
+    # - name: Current Env
+    #   shell: bash
+    #   run: |
+    #     echo ::group::Environment
+    #     echo "Current dir:"
+    #     pwd
+
+    #     echo "Environment Variables:"
+    #     env | sort -u
+    #     echo ::endgroup::
+
+    # On Windows we dont have such problems with permission.
+    # Also we don't have sudo there, so just skip this step
+    # on this platform:
+    - if: inputs.cache == 'true' && runner.os != 'Windows'
+      name: Grant All Perms to Make Roswell Cache Restoring Possible
+      shell: lispsh -eo pipefail {0}
+      run: |
+        sudo mkdir -p /usr/local/etc/roswell
+        sudo chown "${USER}" /usr/local/etc/roswell
+        # Here the ros binary will be restored:
+        sudo chown "${USER}" /usr/local/bin
+
+    - if: inputs.cache == 'true'
+      name: Restore Roswell From Cache
+      id: roswell-cache-restore
+      uses: actions/cache/restore@v4
+      with:
+        path: ${{ inputs.roswell-cache-paths }}
+        key: roswell-${{ inputs.roswell-version }}-${{ steps.locals.outputs.current-month }}-${{ env.cache-name }}-${{ runner.os }}-${{ runner.arch }}-${{ env.LISP }}-${{ inputs.cache-suffix }}
+
+    - if: inputs.cache == 'true' && steps.roswell-cache-restore.outputs.cache-hit == 'true'
+      name: Restore Path To Cached Files
+      shell: lispsh -eo pipefail {0}
+      run: |
+        echo $HOME/.roswell/bin >> $GITHUB_PATH
+        echo .qlot/bin >> $GITHUB_PATH
+
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+          echo $HOME/.roswell/lisp/quicklisp/bin >> $GITHUB_PATH
+        fi
+
+
+    # Start the piece which results should be cached
+
+    # On Windows we install roswell using Pacman package manager and don't need this step
+    - if: (inputs.cache == 'false' || steps.roswell-cache-restore.outputs.cache-hit != 'true') && runner.os != 'Windows'
+      name: Install Roswell
+      shell: lispsh -eo pipefail {0}
       run: |
         echo ::group::Installing Roswell dependencies
+
         if [[ "$RUNNER_OS" == "Linux" ]]; then
             sudo apt-get update
             sudo apt-get -y install git build-essential automake libcurl4-openssl-dev
@@ -165,31 +252,51 @@ runs:
         if [[ "$RUNNER_OS" == "macOS" ]]; then
             brew install automake autoconf curl
         fi
-        if [[ "$RUNNER_OS" == "Windows" ]]; then
-            # Installing ASDF requires `make`, so let's make sure it's
-            # available
-            msys2.cmd -c "pacman --noconfirm -S --needed --overwrite '*' make"
-        fi
+
         echo ::endgroup::
 
         if [[ "${{ inputs.roswell-version }}" != "latest" ]]; then
             echo ::group::Installing Roswell ${{ inputs.roswell-version }}
-            curl -L https://raw.githubusercontent.com/roswell/roswell/${{ inputs.roswell-version }}/scripts/install-for-ci.sh | sh -x
+            curl -L https://raw.githubusercontent.com/roswell/roswell/${{ inputs.roswell-version }}/scripts/install-for-ci.sh | bash -xeo pipefail
         else
             echo ::group::Installing latest Roswell
-            curl -L https://raw.githubusercontent.com/roswell/roswell/master/scripts/install-for-ci.sh | sh -x
+            curl -L https://raw.githubusercontent.com/roswell/roswell/master/scripts/install-for-ci.sh | bash -xeo pipefail
+        fi
+
+        if [[ "${{ inputs.dynamic-space-size }}" != "" ]]; then
+            echo ::group::Changing Dynamic Space Size in Roswell Config
+            ros config set dynamic-space-size ${{ inputs.dynamic-space-size }}
         fi
 
         echo ::endgroup::
-    - name: Upgrade Quicklisp dists
-      shell: lispsh {0}
+        
+    - if: inputs.cache == 'false' || steps.roswell-cache-restore.outputs.cache-hit != 'true'
+      name: Upgrade Quicklisp dists
+      shell: lispsh -eo pipefail {0}
       run: |
         # The parent workflow might have caching enabled for Roswell and all
         # the other Lisp files in general, so it's better to tell Quicklisp
         # to update all its dists.
         ros -e "(ql:update-all-dists :prompt nil)"
-    - name: Upgrade ASDF to the Latest Version
-      shell: lispsh {0}
+        
+    - if: inputs.cache == 'false' || steps.roswell-cache-restore.outputs.cache-hit != 'true'
+      name: Install Quicklisp patch for package-inferred systems
+      shell: lispsh -eo pipefail {0}
+      run: |
+        git clone \
+            --no-tags \
+            --single-branch \
+            --depth=1  \
+            https://github.com/40ants/quicklisp-client-fix \
+            ~/.quicklisp-client-fix
+
+        mkdir -p ~/.roswell
+
+        cat $GITHUB_ACTION_PATH/load-quicklisp-fix.lisp >> ~/.roswell/init.lisp
+       
+    - if: inputs.cache == 'false' || steps.roswell-cache-restore.outputs.cache-hit != 'true'
+      name: Upgrade ASDF to the Latest Version
+      shell: lispsh -eo pipefail {0}
       run: |
         if [[ "${{ inputs.asdf-version }}" != "latest" ]]; then
             echo ::group::Installing ASDF ${{ inputs.asdf-version }}
@@ -199,8 +306,10 @@ runs:
             ros install asdf
         fi
         echo ::endgroup::
-    - name: Install Qlot
-      shell: lispsh {0}
+
+    - if: inputs.cache == 'false' || steps.roswell-cache-restore.outputs.cache-hit != 'true'
+      name: Install Qlot
+      shell: lispsh -eo pipefail {0}
       run: |
         if [[ "${{ inputs.qlot-version }}" != "latest" ]]; then
             echo ::group::Installing Qlot ${{ inputs.qlot-version }}
@@ -211,17 +320,32 @@ runs:
         fi
         echo .qlot/bin >> $GITHUB_PATH
         echo ::endgroup::
-    - name: Create Qlot Environment
-      shell: lispsh {0}
+
+    - if: inputs.cache == 'true' && steps.roswell-cache-restore.outputs.cache-hit != 'true'
+      name: Cache Roswell Setup
+      id: roswell-cache-save
+      uses: actions/cache/save@v4
+      with:
+        path: ${{ inputs.roswell-cache-paths }}
+        key: ${{ steps.roswell-cache-restore.outputs.cache-primary-key }}
+
+    # We really need this step go before cache restore,
+    # because it changes qlfile and cache key depends on it.
+    - name: Ensure qlfile exists
+      shell: lispsh -eo pipefail {0}
       run: |
-        echo ::group::Create Qlot Environment
+        echo ::group::Ensure qlfile exists
 
-        if [[ -n "${QLFILE_TEMPLATE}" ]]; then
-            echo "${QLFILE_TEMPLATE}" | ${{ github.action_path }}/templater.ros > qlfile
+        if [[ -n "${{ inputs.qlfile-template }}" ]]; then
+            echo "${{ inputs.qlfile-template }}" | $GITHUB_ACTION_PATH/templater.ros > qlfile
             rm -f qlfile.lock
-        fi
-
-        if [[ -e qlfile ]]; then
+            
+            echo "Created qlfile:"
+            echo '==============='
+            cat qlfile
+            echo '==============='
+            echo ''
+        elif [[ -e qlfile ]]; then
             echo 'Here is content of qlfile:'
             echo '==============='
             cat qlfile
@@ -231,8 +355,35 @@ runs:
             echo 'There is no qlfile. Creating an empty one.'
             touch qlfile
         fi
+            
+        echo ::endgroup::
 
-        qlot install
+    - if: inputs.cache == 'true'
+      name: Restore Qlot Environment
+      id: qlot-cache-restore
+      uses: actions/cache/restore@v4
+      with:
+        path: ${{ inputs.qlot-cache-paths }}
+        key: qlot-${{ steps.locals.outputs.current-month }}-${{ env.cache-name }}-${{ runner.os }}-${{ runner.arch }}-${{ env.QUICKLISP_DIST }}-${{ env.LISP }}-${{ hashFiles('qlfile', 'qlfile.lock', '*.asd') }}-${{ inputs.cache-suffix }}
+
+    - if: inputs.cache == 'true' && steps.qlot-cache-restore.outputs.cache-hit == 'true'
+      name: Restore Path To .qlot/bin
+      shell: lispsh -eo pipefail {0}
+      run: |
+        echo .qlot/bin >> $GITHUB_PATH
+
+    - if: inputs.cache == 'false' || steps.qlot-cache-restore.outputs.cache-hit != 'true'
+      name: Create Qlot Environment
+      shell: lispsh -eo pipefail {0}
+      run: |
+        echo ::group::Create Qlot Environment
+        if [[ "${{ inputs.qlot-no-deps }}" != 'false' ]]; then
+          echo 'Running Qlot with --no-deps argument'
+          qlot install --no-deps
+        else
+          echo 'Running Qlot as usual'
+          qlot install
+        fi
         echo ::endgroup::
       env:
         QLFILE_TEMPLATE: ${{ inputs.qlfile-template }}
@@ -240,13 +391,49 @@ runs:
     # This step will install system and
     # all possible roswell scripts, if the system
     # has them in the roswell/ subdirectory:
-    - name: Install ASDF System
-      shell: lispsh {0}
+    - if: inputs.asdf-system && (inputs.cache == 'false' || steps.qlot-cache-restore.outputs.cache-hit != 'true')
+      name: Install ASDF System
+      shell: lispsh -eo pipefail {0}
+      # Here we'll need to set CL_SOURCE_REGISTRY
+      # when will switch to a new qlot:
       run: |
         echo ::group::Install ASDF System
-        if [[ -n "${{ inputs.asdf-system }}" ]]; then
-            qlot exec ros install ${{ inputs.asdf-system }}
-        else
-            echo "ASDF system wasn't provided."
-        fi
+
+        qlot exec ros install ${{ inputs.asdf-system }}
+            
+        echo ::endgroup::
+
+    - if: inputs.cache == 'true' && steps.qlot-cache-restore.outputs.cache-hit != 'true'
+      name: Cache Qlot Environment
+      id: qlot-cache-save
+      uses: actions/cache/save@v4
+      with:
+        path: ${{ inputs.qlot-cache-paths }}
+        key: ${{ steps.qlot-cache-restore.outputs.cache-primary-key }}
+
+    # End of the cached piece
+
+    - name: Check it is possible to run desired lisp implementation
+      shell: lispsh -eo pipefail {0}
+      # Call ${{ github.action_path }}test.ros does not work on windows
+      # because of backslashes.
+      #
+      # Here we are using sed to transform slashes in the path.
+      # Without this trick it is impossible to run test.ros on Windows.
+      # 
+      # The other way to do the trick is to change write path to GITHUB_PATH.
+      # In this case, GitHub itself will convert backslashes. Hovewer, this
+      # way the path will be added to the PATH variable of the workflow
+      # which used setup-lisp and I consider this is not desired behaviour.
+      run: |
+        echo ::group::Checking if we installed correct Lisp implementation
+        
+        if [[ "$RUNNER_OS" == "Windows" ]]; then
+            ACTION_PATH="$(echo '${{ github.action_path }}' | sed -e 's|/|\\|')\\"
+        else
+            ACTION_PATH='${{ github.action_path }}/'
+        fi
+        
+        ${ACTION_PATH}test.ros
+
         echo ::endgroup::

changelog.lisp

@@ -1,11 +1,104 @@
-(defpackage #:project-docs/changelog
+(uiop:define-package #:project-docs/changelog
   (:use #:cl)
   (:import-from #:40ants-doc/changelog
                 #:defchangelog))
 (in-package project-docs/changelog)
 
 
-(defchangelog (:ignore-words ("ASDF"))
+(defchangelog (:ignore-words ("ASDF"
+                              "PATH"
+                              "CL"
+                              "SBCL"
+                              "HOME"))
+
+  (4.2.1 2024-12-15
+         "Fixed the way how we set dynamic-space-size.")
+  (4.2.0 2024-12-14
+         "Input variable `dynamic-space-size` was added. It can be used to default set memory size for SBCL.")
+  (4.1.0 2024-05-17
+         "
+# Added
+
+* Input argument qlot-no-deps was added.
+
+  Make Qlot ignore asd files and their dependencies.
+
+  This this might be useful in rare cases when your project contains a non-readable asd files such as templates.")
+  (4.0.5 2024-04-19
+         "
+# Fixed
+
+* Extended test matrix with macos-14 runner.
+* Fixed Roswell cache paths for macos-14 runner.
+* Extended qlot cache key with runner architecture.
+")
+  (4.0.4 2024-04-18
+         "
+# Fixed
+
+* Cache key was extended with runner architecture. Thanks for the contribution to Ákos Kiss!
+")
+  (4.0.3 2024-03-12
+         "
+# Fixed
+
+* There was an error when action suceeded, but actually failed trying to load my quicklisp fix for package inferred systems.
+  A code to load this fix used :HOME as a pathname component which is not supported by some CL implementations. Actually,
+  I've already fixed this issue in 3.1.0 version, but somehow this fix was lost. Also, a handler-bind wrapper around the loader was added
+  and now action's tests will fail in case of any errors.
+")
+  (4.0.2 2024-02-27
+         "
+# Fixed
+
+* Fix recreating of qlfile inside qlot environment cache.
+
+  When some jobs used qlfile-template argument + caching, a template application
+  result was cached and caused an error during the next run.
+")
+  (4.0.1 2024-02-25
+         "
+# Fixed
+
+* Fixed loading of quicklisp-osx-fix. Previously the script made unnecessary output and when you had a `qlfile` template in your workflow this output leaked into `qlfile` broking following `qlot install`.
+")
+  (4.0.0 2024-02-24
+         "
+# Changed
+
+* Internal cache mechanism was added. Now action caches Roswell and Qlot files to speed up reruns. For example, without cache action could be executed about 4 minutes, and with cache it runs only 20 seconds on Ubuntu or 1 minute on Windows.
+* A new input variable `cache` was added to control caching beheviour. It is `true` by default, but you can switch it to `false` to turn caching off.
+
+")
+  (3.2.0 2024-01-30
+         "
+# Changed
+
+* Now action uses `bash -xeo pipefail` for running Roswell install script. This way, in case of some errors inside the script, it will be interrupted immediately.
+* Also, we don't attempt to set `ROSWELL_INSTALL_DIR` env variable anymore, because despite it's presence, Roswell was installed into `/mingw64/bin/` instead under Windows and it works well (at least for me).
+* Now we don't add action's directory to the `PATH` using modification of `GITHUB_PATH` variable. This prevents modification of the `PATH` of a workflow called the action.
+
+# Fixed
+
+* Fixed running of test.ros script under Windows.
+
+")
+  (3.1.0 2024-01-27
+         "
+# Changed
+
+* Switched from Roswell v21.10.14.111 to v23.10.14.114.
+* Now action checks if it is really installed requested Lisp implementation.
+* A list of supported implementation was added to the documentation.
+* Some implementation supported by Roswell, have problems. If you need them, please, contribute the fix either to this action or to the Roswell itself.
+
+# Fixed
+
+* Now all steps fail-fast on the first encountered error. Previously some step might be failed, but action's execution was considered success.
+* Fixed Quicklisp fix activation for lisp implementations which are not support :HOME as part of the pathname.
+")
+  (3.0.0 2023-12-14
+         "Now action uses a fix for Quicklisp client which makes it possible to load package inferred ASDF systems by name of the subsystem.")
   (2.1.0 2022-11-10
          "Moved to newer action msys2/setup-msys2@2.14.2 where a warning about stale Node.js version is fixed.")
   (2.0.0 2021-10-28

ci.lisp

@@ -2,10 +2,17 @@
   (:use #:cl)
   (:import-from #:40ants-ci/workflow
                 #:defworkflow)
-  (:import-from #:40ants-ci/jobs/docs))
+  (:import-from #:40ants-ci/jobs/docs)
+  (:import-from #:40ants-ci/jobs/autotag)
+  (:import-from #:40ants-ci/jobs/linter))
 (in-package project-docs/ci)
 
 
+(defworkflow release
+  :on-push-to "master"
+  :jobs ((40ants-ci/jobs/autotag:autotag)))
+
+
 (defworkflow docs
   :on-push-to "master"
   :on-pull-request t

docs.lisp

@@ -1,6 +1,7 @@
-(defpackage #:project-docs
+(uiop:define-package #:project-docs
   (:use #:cl)
   (:nicknames #:project-docs/docs)
+  
   (:import-from #:40ants-doc
                 #:defsection
                 #:defsection-copy)
@@ -18,7 +19,12 @@
   ;; 40ANTS-DOC-THEME-40ANTS system will bring
   ;; as dependency a full 40ANTS-DOC but we don't want
   ;; unnecessary dependencies here:
-  (ql:quickload :40ants-doc-theme-40ants)
+  #+quicklisp
+  (uiop:symbol-call :ql :quickload
+                    :40ants-doc-theme-40ants)
+  #-quicklisp
+  (asdf:load-system :40ants-doc-theme-40ants)
+  
   (list :theme
         (find-symbol "40ANTS-THEME"
                      (find-package "40ANTS-DOC-THEME-40ANTS"))))
@@ -40,6 +46,7 @@ necessary to make available [Roswell](https://github.com/roswell/roswell)
 and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
 "
   (@features section)
+  (@implementation-support section)
   (@typical-usage section)
   (@roswell-version section)
   (@asdf-version section)
@@ -64,9 +71,42 @@ and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
   `qlfile`, see \"Overriding qlfile\" section.
 * And finally, it can install a specified ASDF system and all it's dependencies.
   But this step is optional.
+* Installed Roswell, `.qlot` and `~/.cache/common-lisp/` files are cached to speed up
+  repeated builds.
 ")
 
 
+(defsection @implementation-support (:title "Implementation support")
+  "
+Most implementations are tested on Linux, but for some of them Windows and OSX are also should work.
+
+Note, that for correct execution, your workflow should use `lispsh -eo pipefail` instead of default `bash`.
+This way a workflow will work Linux, OSX and Windows. You you will ignore this advice, you'll see such error
+when trying to call `ros` or `qlot` scripts:
+
+```
+/c/Users/runneradmin/.roswell/lisp/quicklisp/bin/qlot: line 4: exec: ros: not found
+  Error: Process completed with exit code 127.
+```
+
+| **Implementation** | **Linux**                                            | **OSX** | **Windows**  |
+|--------------------|------------------------------------------------------|---------|--------------|
+| abcl-bin           | ✅                                                   | ✅      | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| allegro            | [❌](https://github.com/40ants/setup-lisp/issues/22) |         |              |
+| ccl-bin            | ✅                                                   | ✅      | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| clasp              | [❌](https://github.com/40ants/setup-lisp/issues/16) |         | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| clasp-bin          | ✅                                                   | [❌](https://github.com/40ants/setup-lisp/issues/29) |
+| clisp              | [❌](https://github.com/40ants/setup-lisp/issues/15) |         | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| clisp-head         | ✅                                                   | [❌](https://github.com/40ants/setup-lisp/issues/28) |
+| cmu-bin            | ✅                                                   | [❌](https://github.com/40ants/setup-lisp/issues/30) | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| ecl                | ✅                                                   | ✅      | [❌](https://github.com/40ants/setup-lisp/issues/27) |
+| mkcl               | [❌](https://github.com/40ants/setup-lisp/issues/17) |         |              |
+| npt                | [❌](https://github.com/40ants/setup-lisp/issues/18) |         |              |
+| sbcl               | ✅                                                   |         |              |
+| sbcl-bin           | ✅                                                   | ✅      | ✅           |
+
+")
+
 (defsection @typical-usage (:title "A typical usage")
   "
 Here is how a minimal GitHub Workflow might look like:
@@ -95,8 +135,8 @@ jobs:
       LISP: ${{ matrix.lisp }}
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: 40ants/setup-lisp@v2
+      - uses: actions/checkout@v4
+      - uses: 40ants/setup-lisp@v4
         with:
           asdf-system: cl-info
       - uses: 40ants/run-tests@v2
@@ -107,7 +147,7 @@ jobs:
 The part, corresponding to an action call is:
 
 ```yaml
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     asdf-system: cl-info
 ```
@@ -136,7 +176,7 @@ working with this action. However, should you need to use a different version
 instead, you can specify that via the `roswell-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     roswell-version: v21.10.14.111
 ```
@@ -150,7 +190,7 @@ working with this action.  However, should you need to use a different version
 instead, you can specify that via the `asdf-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     asdf-version: 3.3.5.3
 ```
@@ -164,7 +204,7 @@ working with this action.  However, should you need to use a different version
 instead, you can specify that via the `qlot-version` argument:
 
 ```
-- uses: 40ants/setup-lisp@v2
+- uses: 40ants/setup-lisp@v4
   with:
     qlot-version: 0.11.5
 ```
@@ -201,8 +241,8 @@ env:
   QUICKLISP_DIST: ${{ matrix.quicklisp-dist }}
 
 steps:
-  - uses: actions/checkout@v2
-  - uses: 40ants/setup-lisp@v2
+  - uses: actions/checkout@v4
+  - uses: 40ants/setup-lisp@v4
     with:
       asdf-system: cl-info
       qlfile-template: |
@@ -232,58 +272,17 @@ Usually installing Roswell, a lisp implementation and dependencies
 take from 2 to 10 minutes. Multiply this to the number of
 matrix combinations and you'll get signifficant time.
 
-To speed up build, you can use caching using a standad GitHub action `actions/cache@v2`.
+Starting from version `4.0.0`, this action cares about caching itself
+and you don't need to wrap it with `actions/cache`. This behaviour
+of enabled by default. Without cache action could be executed about
+4 minutes, and with cache it runs only 20 seconds on Ubuntu or 1 minute on Windows.
 
-To make caching work, add such sections into your workflow file:
+A new input variable `cache` was added to control caching beheviour.
+It is `true` by default, but you can switch it to `false` to turn caching off.
 
-```yaml
-- name: Grant All Perms to Make Cache Restoring Possible
-  run: |
-    sudo mkdir -p /usr/local/etc/roswell
-    sudo chown \"${USER}\" /usr/local/etc/roswell
-    # Here the ros binary will be restored:
-    sudo chown \"${USER}\" /usr/local/bin
-- name: Get Current Month
-  id: current-month
-  run: |
-    echo \"::set-output name=value::$(date -u \"+%Y-%m\")\"
-- name: Cache Roswell Setup
-  id: cache
-  uses: actions/cache@v2
-  env:
-    cache-name: cache-roswell
-  with:
-    path: |
-      /usr/local/bin/ros
-      ~/.cache/common-lisp/
-      ~/.roswell
-      /usr/local/etc/roswell
-      .qlot
-    key: \"${{ steps.current-month.outputs.value }}-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles('qlfile.lock') }}\"
-- name: Restore Path To Cached Files
-  run: |
-    echo $HOME/.roswell/bin >> $GITHUB_PATH
-    echo .qlot/bin >> $GITHUB_PATH
-  if: steps.cache.outputs.cache-hit == 'true'
-- uses: 40ants/setup-lisp@v2
-  if: steps.cache.outputs.cache-hit != 'true'
-```
-
-There are two important lines here.
-
-- The last line `if: steps.cache.outputs.cache-hit != 'true'` skips
-  running lisp installation, it it was take from the cache.
-- The `key` value:
-
-  ```
-  key: \"${{ steps.current-month.outputs.value }}-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles('qlfile.lock') }}\"
-  ```
-
-  It controls when your cache will be matched. If you are using `matrix`, put all it's components
-  into the key.
-
-  I also added a current month there, to make sure cache will be renewed at least monthly.
-  This way a new Roswell, Qlot and ASDF will be used in a build.
+The current month is used as part of the cache key, to refresh caches every month.
+This way a new Roswell, Qlot and ASDF will be used in a build. Also, you can set
+`env.cache-name` variable to some value, to force rebuild with a fresh cache.
 ")
 
 

load-quicklisp-fix.lisp

@@ -0,0 +1,19 @@
+(handler-bind ((serious-condition
+                 (lambda (condition)
+                   (uiop:print-condition-backtrace condition)
+                   (uiop:quit 1))))
+  (let ((fix-filename (merge-pathnames
+                       (make-pathname :directory '(:relative ".quicklisp-client-fix")
+                                      :name "quicklisp-fix"
+                                      :type "lisp")
+                       (user-homedir-pathname))))
+    (let ((quicklisp-found #+quicklisp t
+                           #-quicklisp nil))
+      (cond
+        ((not quicklisp-found)
+         (warn "Quicklisp is not available, skipping fix loading.~%"))
+        ((probe-file fix-filename)
+         (handler-bind ((warning #'muffle-warning))
+           (load fix-filename)))
+        (t
+         (warn "Quicklisp fix was not found at ~S.~%" fix-filename))))))

qlfile.lock

@@ -1,11 +1,11 @@
 ("quicklisp" .
  (:class qlot/source/dist:source-dist
-  :initargs (:distribution "http://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest)
-  :version "2022-11-07"))
+  :initargs (:distribution "https://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest)
+  :version "2024-10-12"))
 ("ultralisp" .
  (:class qlot/source/dist:source-dist
-  :initargs (:distribution "http://dist.ultralisp.org" :%version :latest)
-  :version "20221109175500"))
+  :initargs (:distribution "https://dist.ultralisp.org" :%version :latest)
+  :version "20241214090000"))
 ("sly" .
  (:class qlot/source/github:source-github
   :initargs (:repos "svetlyak40wt/sly" :ref nil :branch "patches" :tag nil)

test.ros

@@ -0,0 +1,68 @@
+#!/bin/sh
+#|-*- mode:lisp -*-|#
+#|
+exec ros -Q -- $0 "$@"
+|#
+(progn ;;init forms
+  (ros:ensure-asdf)
+  #+quicklisp(ql:quickload '() :silent t)
+  )
+
+(defpackage :ros.script.test
+  (:use :cl))
+(in-package :ros.script.test)
+
+
+(defparameter *lisps*
+  '(("sbcl-bin" . "SBCL")
+    ("sbcl" . "SBCL")
+    ("clisp" . "CLISP")
+    ("clisp-head" . "CLISP")
+    ("ccl-bin" . "Clozure Common Lisp")
+    ("clasp" . "clasp")
+    ("clasp-bin" . "clasp")
+    ("cmu-bin" . "CMU Common Lisp")
+    ("allegro" . "International Allegro CL Free Express Edition")
+    ("abcl-bin" . "Armed Bear Common Lisp")
+    ("npt" . "NPT")
+    ("ecl" . "ECL")))
+
+
+(defun cut-before (char text)
+  (let ((pos (position char text)))
+    (if pos
+        (subseq text 0 pos)
+        text)))
+
+
+(defun main (&rest argv)
+  (declare (ignorable argv))
+  (handler-bind ((error (lambda (c)
+                          (uiop:print-condition-backtrace c)
+                          ;; Not all implementation do quit with correct status code
+                          ;; in case if we just signal and error :(
+                          ;; Example of such implementations: CCL-BIN 
+                          (uiop:quit 1))))
+    (let ((needed-lisp (uiop:getenv "LISP")))
+      (unless needed-lisp
+        (error "Env variable LISP was not set."))
+     
+      (let ((expected (or (cdr (assoc needed-lisp *lisps* :test #'string-equal))
+                          (cdr (assoc (cut-before #\/ needed-lisp) *lisps* :test #'string-equal))))
+            (real-implementation (lisp-implementation-type)))
+        (unless expected
+          (error "This test does not support LISP=~A. The real-implementation=~A."
+                 needed-lisp
+                 real-implementation))
+       
+        (unless (string-equal real-implementation
+                              expected)
+          (error "Real implementation is \"~A\", but \"~A\" was expected when LISP=~A."
+                 real-implementation
+                 expected
+                 needed-lisp))
+
+        (format t "Everything ok, we are running on \"~A\" as expected for LISP=~A."
+                real-implementation
+                needed-lisp)))))
+;;; vim: set ft=lisp lisp: