Compare commits

...

37 commits
v3 ... master

Author SHA1 Message Date
github-actions[bot]
76212e4597 Update docs 2024-12-14 22:08:30 +00:00
Alexander Artemenko
37d6351ff1 Fixed the way how we set dynamic-space-size. 2024-12-14 22:05:20 +00:00
github-actions[bot]
0bbf4764f4 Update docs 2024-12-14 10:03:04 +00:00
Alexander Artemenko
c5aaeb1ffc
Merge pull request from 40ants/dynamic-space-size
Input variable `dynamic-space-size` was added. It can be used to default set memory size for SBCL.
2024-12-14 12:58:18 +03:00
Alexander Artemenko
55b7212e25 Fixed small problem in the docs. 2024-12-14 09:51:14 +00:00
Alexander Artemenko
9467768eb5 Input variable dynamic-space-size was added. It can be used to default set memory size for SBCL. 2024-12-14 09:37:59 +00:00
github-actions[bot]
b6c2357e52 Update docs 2024-08-04 07:22:35 +00:00
Alexander Artemenko
f3e4144589
Merge pull request from 40ants/qlot-no-deps-mode
Qlot no deps mode
2024-08-04 10:17:22 +03:00
Alexander Artemenko
da8536f4ff Fixed condition. 2024-05-18 00:22:24 +03:00
Alexander Artemenko
fe2e6f885e Add more logging. 2024-05-18 00:21:32 +03:00
Alexander Artemenko
e14ce570fc Updated the changelog. 2024-05-17 16:19:34 +03:00
Alexander Artemenko
976b3e5419 Input argument qlot-no-deps was added.
It makes Qlot to 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.
2024-05-17 15:59:07 +03:00
github-actions[bot]
1e6a66be39 Update docs 2024-04-26 07:16:07 +00:00
Alexander Artemenko
1a45deaa8e
Merge pull request from ak-coram/macos-14-cache-fixes
macos-14 caching fixes
2024-04-26 10:12:59 +03:00
Ákos Kiss
abd311bead Update changelog 2024-04-19 10:22:53 +02:00
Ákos Kiss
f4185fed53 Add macos-14 to test matrix 2024-04-19 10:18:38 +02:00
Ákos Kiss
4d80952994 Add homebrew paths to roswell cache for macos-14 2024-04-19 05:09:28 +02:00
Ákos Kiss
98a5a9d323 Extend qlot cache key with runner architecture 2024-04-19 05:05:56 +02:00
github-actions[bot]
cf2feb4223 Update docs 2024-04-18 08:10:23 +00:00
Alexander Artemenko
f243cb8ff6 Update changelog. 2024-04-18 11:07:18 +03:00
Alexander Artemenko
a5179c83cc
Merge pull request from ak-coram/extend-cache-key-with-runner-arch
Extend cache key with runner architecture (fixes )
2024-04-18 11:01:51 +03:00
Ákos Kiss
2050461d6f Extend cache key with runner architecture 2024-04-18 04:31:06 +02:00
github-actions[bot]
08730d2cc2 Update docs 2024-04-15 15:27:08 +00:00
Alexander Artemenko
48b749e1f2
Merge pull request from 40ants/fix-ql-fix-loading
Fix :HOME path component issue.
2024-04-15 18:24:25 +03:00
Alexander Artemenko
cb334f930e Fix :HOME path component issue.
First, we need to ensure that any errors in quicklisp fix loader cause failure of our own tests.
2024-04-15 18:08:08 +03:00
Alexander Artemenko
9eb7a325f3 Update deps. 2024-03-06 02:08:05 +03:00
github-actions[bot]
d59bda940d Update docs 2024-02-27 22:26:29 +00:00
Alexander Artemenko
b9bed49497
Merge pull request from 40ants/fix-recreating-of-qlfile-inside-cache
Fix recreating of qlfile inside qlot environment cache.
2024-02-28 01:23:42 +03:00
Alexander Artemenko
d1afc4a2c7 Update changelog. 2024-02-28 01:17:35 +03:00
Alexander Artemenko
78562d4bed Fix recreating of qlfile inside qlot environment cache. 2024-02-28 00:28:17 +03:00
github-actions[bot]
9e4feeebbc Update docs 2024-02-25 16:05:23 +00:00
Alexander Artemenko
0fe284ebfe
Merge pull request from 40ants/fix-ql-osx-fix
Fixed loading of quicklisp-osx-fix
2024-02-25 19:02:46 +03:00
Alexander Artemenko
397c5328a9 Disabled test for allegro. 2024-02-25 13:55:01 +00:00
Alexander Artemenko
a7e183c1bc 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`.
2024-02-25 13:47:08 +00:00
github-actions[bot]
f1fddbf686 Update docs 2024-02-24 21:40:02 +00:00
Alexander Artemenko
d05de90b76
Merge pull request from 40ants/use-cache
Use cache
2024-02-25 00:37:17 +03:00
Alexander Artemenko
d52785caf1 Added cache support inside the action itself. Now it can run up to 10 times faster! 2024-02-24 21:30:03 +00:00
9 changed files with 563 additions and 241 deletions

View file

@ -14,45 +14,105 @@ jobs:
fail-fast: false # Let the workflow continue as much as possible
matrix:
include:
- 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: macos-latest
lisp: sbcl-bin
- os: windows-latest
lisp: sbcl-bin
- os: ubuntu-latest
lisp: sbcl-bin
- os: ubuntu-latest
lisp: ccl-bin
- os: ubuntu-latest
lisp: clisp-head
- os: ubuntu-latest
lisp: ecl
- os: ubuntu-latest
lisp: allegro
# Linux
- os: ubuntu-latest
lisp: abcl-bin
- os: ubuntu-latest
lisp: clasp-bin
- os: ubuntu-latest
lisp: cmu-bin
# See issue: https://github.com/40ants/setup-lisp/issues/15
# See issue: https://github.com/40ants/setup-lisp/issues/22
# - os: ubuntu-latest
# lisp: clisp
# 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
# 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 -eo pipefail {0}
@ -82,8 +142,11 @@ jobs:
# https://github.com/roswell/roswell/issues/497
asdf-version: 3.3.5.3
qlot-version: latest
- run: which ros
- run: ros config
# 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

1
.gitignore vendored
View file

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

View file

@ -2,9 +2,104 @@
# 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 (2023-01-30)
## 3.2.0 (2024-01-30)
<a id="changed"></a>
@ -22,7 +117,7 @@
<a id="x-28PROJECT-DOCS-2FCHANGELOG-3A-3A-7C3-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## 3.1.0 (2023-01-27)
## 3.1.0 (2024-01-27)
<a id="changed"></a>

111
README.md
View file

@ -22,6 +22,8 @@ and [Qlot][e3ea] 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.
<a id="x-28PROJECT-DOCS-3A-3A-40IMPLEMENTATION-SUPPORT-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
@ -37,21 +39,21 @@ 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** | **Supported** |
| --- | --- |
| abcl-bin | ✅ |
| allegro | |
| ccl-bin | ✅ |
| clasp | [❌][ecc6] |
| clasp-bin | ✅ |
| clisp | [❌][78c5] |
| clisp-head | ✅ |
| cmu-bin | ✅ |
| ecl | ✅ |
| mkcl | [❌][2801] |
| npt | [❌][7189] |
| sbcl | ✅ |
| sbcl-bin | ✅ |
| **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>
@ -83,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
@ -94,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
```
@ -121,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
```
@ -134,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
```
@ -147,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
```
@ -182,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: |
@ -212,57 +214,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.
<a id="x-28PROJECT-DOCS-3A-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
@ -287,6 +249,11 @@ If you want to contribute to this system, join development at GitHub:
[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

View file

@ -1,44 +1,114 @@
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: 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: |
@ -63,7 +133,7 @@ runs:
# 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
@ -121,17 +191,56 @@ 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
# 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
@ -143,11 +252,7 @@ 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
@ -158,15 +263,24 @@ runs:
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
- 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: Install Quicklisp patch for package-inferred systems
- 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 \
@ -178,23 +292,10 @@ runs:
mkdir -p ~/.roswell
cat >> ~/.roswell/init.lisp <<EOF
(handler-bind ((error #'(lambda (c)
(uiop:print-condition-backtrace c)
(uiop:quit 1))))
(let ((fix-filename (merge-pathnames
(make-pathname :directory '(:relative ".quicklisp-client-fix")
:name "quicklisp-fix"
:type "lisp")
(user-homedir-pathname))))
(cond
((probe-file fix-filename)
(format t "Loading quicklisp fix.~%")
(load fix-filename))
(t
(format t "Quicklisp fix was not found at ~S.~%" fix-filename)))))
EOF
- name: Upgrade ASDF to the Latest Version
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
@ -205,7 +306,9 @@ runs:
ros install asdf
fi
echo ::endgroup::
- name: Install Qlot
- 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
@ -217,17 +320,32 @@ runs:
fi
echo .qlot/bin >> $GITHUB_PATH
echo ::endgroup::
- name: Create Qlot Environment
- 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
@ -237,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 }}
@ -246,18 +391,28 @@ runs:
# This step will install system and
# all possible roswell scripts, if the system
# has them in the roswell/ subdirectory:
- name: Install ASDF System
- 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

View file

@ -7,8 +7,70 @@
(defchangelog (:ignore-words ("ASDF"
"PATH"
"CL"
"SBCL"
"HOME"))
(3.2.0 2023-01-30
(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
@ -21,7 +83,7 @@
* Fixed running of test.ros script under Windows.
")
(3.1.0 2023-01-27
(3.1.0 2024-01-27
"
# Changed

108
docs.lisp
View file

@ -71,6 +71,8 @@ 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.
")
@ -87,22 +89,21 @@ when trying to call `ros` or `qlot` scripts:
Error: Process completed with exit code 127.
```
| **Implementation** | **Supported** |
|--------------------|------------------------------------------------------|
| abcl-bin | |
| allegro | |
| ccl-bin | |
| clasp | [](https://github.com/40ants/setup-lisp/issues/16) |
| clasp-bin | |
| clisp | [](https://github.com/40ants/setup-lisp/issues/15) |
| clisp-head | |
| cmu-bin | |
| ecl | |
| mkcl | [](https://github.com/40ants/setup-lisp/issues/17) |
| npt | [](https://github.com/40ants/setup-lisp/issues/18) |
| sbcl | |
| sbcl-bin | |
| **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 | | ✅ | |
")
@ -134,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
@ -146,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
```
@ -175,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
```
@ -189,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
```
@ -203,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
```
@ -240,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: |
@ -271,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.
")

19
load-quicklisp-fix.lisp Normal file
View file

@ -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))))))

View file

@ -1,11 +1,11 @@
("quicklisp" .
(:class qlot/source/dist:source-dist
:initargs (:distribution "http://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest)
:version "2023-10-21"))
: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 "20240127152000"))
: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)