Update docs

This commit is contained in:
github-actions[bot] 2021-04-22 20:44:41 +00:00
parent 77765f0875
commit 660773074c

View file

@ -1,17 +1,17 @@
<a id='x-28DOCS-3A-40INDEX-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-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?][a4be] - [1 What this action does for you?][57c1]
- [2 A typical usage][3b34] - [2 A typical usage][6952]
- [3 Overriding qlfile][8d79] - [3 Overriding qlfile][cd23]
- [4 Caching][5f3e] - [4 Caching][33c1]
- [5 Roadmap][0187] - [5 Roadmap][bc0f]
- [6 Contribution][e0ca] - [6 Contribution][b507]
###### \[in package DOCS with nicknames DOCS/DOCS\] ###### \[in package PROJECT-DOCS with nicknames PROJECT-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.
It is useful to call it before running tests or building docs It is useful to call it before running tests or building docs
@ -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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-3A-40QL-FILE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 3 Overriding qlfile ## 3 Overriding qlfile
@ -157,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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-3A-40CACHING-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 4 Caching ## 4 Caching
@ -219,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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 5 Roadmap ## 5 Roadmap
@ -228,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-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a> <a id='x-28PROJECT-DOCS-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29'></a>
## 6 Contribution ## 6 Contribution
@ -236,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>
[0187]: #x-28DOCS-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Roadmap" [33c1]: #x-28PROJECT-DOCS-3A-40CACHING-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Caching"
[3b34]: #x-28DOCS-3A-40TYPICAL-USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "A typical usage" [57c1]: #x-28PROJECT-DOCS-3A-40FEATURES-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "What this action does for you?"
[5f3e]: #x-28DOCS-3A-40CACHING-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Caching" [6952]: #x-28PROJECT-DOCS-3A-40TYPICAL-USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "A typical usage"
[8d79]: #x-28DOCS-3A-40QL-FILE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Overriding qlfile" [b507]: #x-28PROJECT-DOCS-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Contribution"
[a4be]: #x-28DOCS-3A-40FEATURES-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "What this action does for you?" [bc0f]: #x-28PROJECT-DOCS-3A-40ROADMAP-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Roadmap"
[e0ca]: #x-28DOCS-3A-40CONTRIBUTION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Contribution" [cd23]: #x-28PROJECT-DOCS-3A-40QL-FILE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29 "Overriding qlfile"
* * * * * *
###### \[generated by [40ANTS-DOC](https://40ants.com/doc)\] ###### \[generated by [40ANTS-DOC](https://40ants.com/doc)\]