paku/setup-lisp
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Move to 40ants-doc.

Browse source
This commit is contained in:
Alexander Artemenko 2021-04-22 21:57:34 +03:00
parent 8c96f9bc39
commit b7fa0274d2
6 changed files with 85 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

101
.github/workflows/docs.yml vendored
View file

@ -1,55 +1,46 @@
name: 'Docs' {
"name": "DOCS",
on: "on": {
# This will run tests on pushes "push": {
# to master branch and every monday: "branches": [
push: "master"
branches: ]
- 'main' },
- 'master' "schedule": [
schedule: {
- cron: '0 10 * * 1' "cron": "0 10 * * 1"
}
jobs: ]
build-docs: },
runs-on: ubuntu-latest "jobs": {
"build-docs": {
env: "runs-on": "ubuntu-latest",
LISP: sbcl-bin "env": {
"OS": "ubuntu-latest",
steps: "QUICKLISP_DIST": "quicklisp",
- uses: actions/checkout@v1 "LISP": "sbcl-bin"
- name: Grant All Perms to Make Cache Restoring Possible },
run: | "steps": [
sudo mkdir -p /usr/local/etc/roswell {
sudo chown "${USER}" /usr/local/etc/roswell "name": "Checkout Code",
# Here the ros binary will be restored: "uses": "actions/checkout@v1"
sudo chown "${USER}" /usr/local/bin },
- name: Get Current Month {
id: current-month "name": "Setup Common Lisp Environment",
run: | "uses": "40ants/setup-lisp@v1",
echo "::set-output name=value::$(date -u "+%Y-%m")" "with": {
- name: Cache Roswell Setup "asdf-system": "docs"
id: cache }
uses: actions/cache@v2 },
env: {
cache-name: cache-roswell "name": "Build Docs",
with: "uses": "40ants/build-docs@v1",
path: | "with": {
/usr/local/bin/ros "asdf-system": "docs",
~/.cache/common-lisp/ "error-on-warnings": true
~/.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@v1
if: steps.cache.outputs.cache-hit != 'true'
- uses: 40ants/build-docs@v1
with:
asdf-system: docs
# ngrok-auth-token: ${{ secrets.NGROK_AUTH_TOKEN }}

42
README.md
View file

@ -1,15 +1,15 @@
<a id='x-28DOCS-3A-40INDEX-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40INDEX-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
# GitHub Action to Setup Common Lisp for CI # GitHub Action to Setup Common Lisp for CI
## Table of Contents ## Table of Contents
- [1 What this action does for you?][f73c] - [1 What this action does for you?][a4be]
- [2 A typical usage][ff56] - [2 A typical usage][3b34]
- [3 Overriding qlfile][d1d0] - [3 Overriding qlfile][8d79]
- [4 Caching][8d36] - [4 Caching][5f3e]
- [5 Roadmap][278a] - [5 Roadmap][0187]
- [6 Contribution][c105] - [6 Contribution][e0ca]
###### \[in package DOCS with nicknames DOCS/DOCS\] ###### \[in package DOCS with nicknames DOCS/DOCS\]
This is a Github Action to setup Common Lisp, Roswell and Qlot. This is a Github Action to setup Common Lisp, Roswell and Qlot.
@ -19,7 +19,7 @@ for your Common Lisp libraries. Action encapsulates all steps
necessary to make available [Roswell](https://github.com/roswell/roswell) necessary to make available [Roswell](https://github.com/roswell/roswell)
and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI. and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
<a id='x-28DOCS-3A-40FEATURES-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40FEATURES-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 1 What this action does for you? ## 1 What this action does for you?
@ -39,7 +39,7 @@ and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
But this step is optional. But this step is optional.
<a id='x-28DOCS-3A-40TYPICAL-USAGE-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40TYPICAL-USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 2 A typical usage ## 2 A typical usage
@ -101,7 +101,7 @@ env:
The last step in this workflow runs tests for the specified `ASDF` The last step in this workflow runs tests for the specified `ASDF`
system. It is documented [here](https://40ants.com/run-tests). system. It is documented [here](https://40ants.com/run-tests).
<a id='x-28DOCS-3A-40QL-FILE-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40QL-FILE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 3 Overriding qlfile ## 3 Overriding qlfile
@ -140,8 +140,6 @@ steps:
{% ifequal quicklisp_dist "ultralisp" %} {% ifequal quicklisp_dist "ultralisp" %}
dist ultralisp http://dist.ultralisp.org dist ultralisp http://dist.ultralisp.org
{% endifequal %} {% endifequal %}
github mgl-pax svetlyak40wt/mgl-pax :branch mgl-pax-minimal
``` ```
Here we see a few important things. Here we see a few important things.
@ -159,7 +157,7 @@ Also note, it is using [Djula](https://github.com/mmontone/djula)
markup, similar to [Django](https://docs.djangoproject.com/en/3.1/topics/templates/) markup, similar to [Django](https://docs.djangoproject.com/en/3.1/topics/templates/)
and [Jinja2](https://jinja.palletsprojects.com/). and [Jinja2](https://jinja.palletsprojects.com/).
<a id='x-28DOCS-3A-40CACHING-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40CACHING-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 4 Caching ## 4 Caching
@ -221,7 +219,7 @@ It controls when your cache will be matched. If you are using `matrix`, put all
I also added a current month there, to make sure cache will be renewed at least monthly. 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. This way a new Roswell, Qlot and `ASDF` will be used in a build.
<a id='x-28DOCS-3A-40ROADMAP-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 5 Roadmap ## 5 Roadmap
@ -230,7 +228,7 @@ It controls when your cache will be matched. If you are using `matrix`, put all
- Vendor all dependencies, to make action more reliable and secure. - Vendor all dependencies, to make action more reliable and secure.
<a id='x-28DOCS-3A-40CONTRIBUTION-20MGL-PAX-MINIMAL-3ASECTION-29'></a> <a id='x-28DOCS-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 6 Contribution ## 6 Contribution
@ -238,12 +236,12 @@ If you want to contribute to this system, join development at GitHub:
<https://github.com/40ants/setup-lisp> <https://github.com/40ants/setup-lisp>
[278a]: #x-28DOCS-3A-40ROADMAP-20MGL-PAX-MINIMAL-3ASECTION-29 "Roadmap" [0187]: #x-28DOCS-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Roadmap"
[8d36]: #x-28DOCS-3A-40CACHING-20MGL-PAX-MINIMAL-3ASECTION-29 "Caching" [3b34]: #x-28DOCS-3A-40TYPICAL-USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "A typical usage"
[c105]: #x-28DOCS-3A-40CONTRIBUTION-20MGL-PAX-MINIMAL-3ASECTION-29 "Contribution" [5f3e]: #x-28DOCS-3A-40CACHING-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Caching"
[d1d0]: #x-28DOCS-3A-40QL-FILE-20MGL-PAX-MINIMAL-3ASECTION-29 "Overriding qlfile" [8d79]: #x-28DOCS-3A-40QL-FILE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Overriding qlfile"
[f73c]: #x-28DOCS-3A-40FEATURES-20MGL-PAX-MINIMAL-3ASECTION-29 "What this action does for you?" [a4be]: #x-28DOCS-3A-40FEATURES-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "What this action does for you?"
[ff56]: #x-28DOCS-3A-40TYPICAL-USAGE-20MGL-PAX-MINIMAL-3ASECTION-29 "A typical usage" [e0ca]: #x-28DOCS-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Contribution"
* * * * * *
###### \[generated by [MGL-PAX](https://github.com/melisgl/mgl-pax)\] ###### \[generated by [40ANTS-DOC](https://40ants.com/doc)\]

12
ci.lisp Normal file
View file

@ -0,0 +1,12 @@
(defpackage #:docs/ci
(:use #:cl)
(:import-from #:40ants-ci/workflow
#:defworkflow)
(:import-from #:40ants-ci/jobs/docs))
(in-package docs/ci)
(defworkflow docs
:on-push-to "master"
:by-cron "0 10 * * 1"
:jobs ((40ants-ci/jobs/docs:build-docs)))

11
docs.lisp
View file

@ -1,13 +1,14 @@
(defpackage #:docs (defpackage #:docs
(:use #:cl) (:use #:cl)
(:nicknames #:docs/docs) (:nicknames #:docs/docs)
(:import-from #:mgl-pax-minimal (:import-from #:40ants-doc
#:defsection #:defsection))
#:section))
(in-package docs) (in-package docs)
(defsection @index (:title "GitHub Action to Setup Common Lisp for CI") (defsection @index (:title "GitHub Action to Setup Common Lisp for CI"
:ignore-words ("OSX"
"LISP"))
" "
This is a Github Action to setup Common Lisp, Roswell and Qlot. This is a Github Action to setup Common Lisp, Roswell and Qlot.
@ -137,8 +138,6 @@ steps:
{% ifequal quicklisp_dist \"ultralisp\" %} {% ifequal quicklisp_dist \"ultralisp\" %}
dist ultralisp http://dist.ultralisp.org dist ultralisp http://dist.ultralisp.org
{% endifequal %} {% endifequal %}
github mgl-pax svetlyak40wt/mgl-pax :branch mgl-pax-minimal
``` ```
Here we see a few important things. Here we see a few important things.

2
qlfile
View file

@ -1,5 +1,3 @@
dist ultralisp http://dist.ultralisp.org dist ultralisp http://dist.ultralisp.org
# Unless this patch is not merged:
github mgl-pax svetlyak40wt/mgl-pax :branch mgl-pax-minimal
github sly svetlyak40wt/sly :branch patches github sly svetlyak40wt/sly :branch patches

8
qlfile.lock
View file

@ -1,15 +1,11 @@
("quicklisp" . ("quicklisp" .
(:class qlot/source/dist:source-dist (:class qlot/source/dist:source-dist
:initargs (:distribution "http://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest) :initargs (:distribution "http://beta.quicklisp.org/dist/quicklisp.txt" :%version :latest)
:version "2021-01-24")) :version "2021-04-11"))
("ultralisp" . ("ultralisp" .
(:class qlot/source/dist:source-dist (:class qlot/source/dist:source-dist
:initargs (:distribution "http://dist.ultralisp.org" :%version :latest) :initargs (:distribution "http://dist.ultralisp.org" :%version :latest)
:version "20210224171000")) :version "20210422152500"))
("mgl-pax" .
(:class qlot/source/github:source-github
:initargs (:repos "svetlyak40wt/mgl-pax" :ref nil :branch "mgl-pax-minimal" :tag nil)
:version "github-6c4eecc1be34466756e6096d1c5071f5"))
("sly" . ("sly" .
(:class qlot/source/github:source-github (:class qlot/source/github:source-github
:initargs (:repos "svetlyak40wt/sly" :ref nil :branch "patches" :tag nil) :initargs (:repos "svetlyak40wt/sly" :ref nil :branch "patches" :tag nil)