Skip to content

melusina-org/setup-quicklisp

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Setup QuickLisp on GitHub Runners

This GitHub Action installs QuickLisp for various Common Lisp implementations on GitHub Runners.

Continuous Integration

This action is complemented by other actions related to the Common Lisp eco system:

Usage

Create a workflow file in the.github/workflows directory of your working copy. This workflow file should use a MacOS runner or a Ubuntu Runner and use the branch v1 of this action.

An example workflow is available below. See the GitHub Help Documentation for Creating a workflow file to get started with GitHub workflows.

Outcomes

Once the action has been executed succesfully, the required Common Lisp implementation can use QuickLisp.

Inputs

  • implementation — The Common Lisp implementation to setup QuickLisp for. This can be one of the values abcl ecl sbcl and in the future we would like to support all of abcl clasp clisp ecl gcl sbcl and maybe other implementations. Please open an issue to express interest for other implementations.

  • additional-systems — When set, the list of additional systems to load with QuickLisp.

Outputs

  • quicklisp-home: The home directory where QuickLisp is installed.
  • quicklisp-local-projects: The directory where QuickLisp local projects are searched.

Example Workflow

name: 'Continuous Integration'
on:
  - workflow_dispatch
  - push

jobs:
  install-quicklisp-on-tier-1-platforms:
    strategy:
      matrix:
        implementation: ['abcl', 'ecl', 'sbcl']
        os: ['ubuntu-latest', 'macos-11', 'macos-12', 'macos-13']
    runs-on: '${{ matrix.os }}'
    name: 'Install Common Lisp'
    steps:
      - uses: actions/checkout@v3
      - name: 'Install MacPorts'
        if: runner.os == 'macOS'
        uses: melusina-org/setup-macports@v1
      - uses: melusina-org/setup-common-lisp@v1
        with:
          implementation: '${{ matrix.implementation }}'
      - uses: melusina-org/setup-quicklisp@v1
        id: 'quicklisp'
        with:
          implementation: '${{ matrix.implementation }}'
      - name: 'Validate installed implementation'
        run: |
          test -d '${{ steps.quicklisp.outputs.quicklisp-home }}'
          test -d '${{ steps.quicklisp.outputs.quicklisp-local-projects }}'

License

The scripts and documentation in this project are released under the MIT License