Skip to content

Commit

Permalink
Prepare initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
foretspaisibles committed Sep 14, 2023
1 parent cbabc2c commit 82ecccc
Show file tree
Hide file tree
Showing 5 changed files with 153 additions and 8 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/continuous-integration.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
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: ./
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 }}'
install-quicklisp-on-tier-2-platforms:
needs: install-quicklisp-on-tier-1-platforms
strategy:
matrix:
implementation: ['clisp', 'gcl']
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
continue-on-error: true
with:
implementation: '${{ matrix.implementation }}'
- uses: ./
continue-on-error: true
id: 'quicklisp'
with:
implementation: '${{ matrix.implementation }}'
- name: 'Validate installed implementation'
continue-on-error: true
run: |
test -d '${{ steps.quicklisp.outputs.quicklisp-home }}'
test -d '${{ steps.quicklisp.outputs.quicklisp-local-projects }}'
84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Setup QuickLisp on GitHub Runners

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

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

- [setup-common-lisp](https://github.com/melusina-org/setup-common-lisp)
- [asdf-operate](https://github.com/melusina-org/asdf-operate)
- [run-common-lisp-program](https://github.com/melusina-org/run-common-lisp-program)
- [make-lisp-system-documentation-texinfo](https://github.com/melusina-org/make-lisp-system-documentation-texinfo)


## 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](#example-workflow) is available below. See the GitHub Help Documentation for
[Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#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.


## Outputs

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


## Example Workflow

```yaml
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: ./
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](LICENSE)
16 changes: 10 additions & 6 deletions action.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
name: 'Setup Common Lisp'
name: 'Setup QuickLisp'
description: >-
Setup Common Lisp on a GitHub Runner.
Setup QuickLisp on a GitHub Runner where Common Lisp
is already installed.
branding:
icon: box
color: blue
inputs:
implementation:
description: |
The Common Lisp implementation to setup. This can be one of the
following values:
The Common Lisp implementation to setup QuickLisp for.
This can be one of the following values:
abcl ecl sbcl
Expand All @@ -20,9 +20,13 @@ inputs:
default: 'sbcl'
outputs:
quicklisp-home:
value: ${{ steps.setup-quicklisp.outputs.quicklisp-home }}
value: '${{ steps.setup-quicklisp.outputs.quicklisp-home }}'
description: >-
The installation directory for the QuickLisp distribution.
quicklisp-local-projects:
value: '${{ steps.setup-quicklisp.outputs.quicklisp-home }}/local-projects'
description: >-
The local project directory for the QuickLisp distribution.
runs:
using: 'composite'
steps:
Expand Down
2 changes: 1 addition & 1 deletion setup-quicklisp.lisp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
;;;; setup-quicklisp.lisp — Setup QuickLisp

;;;; Melusina Actions (https://github.com/melusina-org/actions)
;;;; Melusina Actions (https://github.com/melusina-org/setup-quicklisp)
;;;; This file is part of Melusina Actions.
;;;;
;;;; Copyright © 2023 Michaël Le Barbier
Expand Down
2 changes: 1 addition & 1 deletion with_lisp_implementation
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# with_lisp_implementation — Load Lisp Scripts with the given implementation

# Melusina Actions (https://github.com/melusina-org/actions)
# Melusina Actions (https://github.com/melusina-org/setup-quicklisp)
# This file is part of Melusina Actions.
#
# Copyright © 2023 Michaël Le Barbier
Expand Down

0 comments on commit 82ecccc

Please sign in to comment.