Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/40ants/ci

Highly opionated Github Actions workflow builder for Common Lisp projects.
https://github.com/40ants/ci

ci common-lisp github-actions

Last synced: 3 months ago
JSON representation

Highly opionated Github Actions workflow builder for Common Lisp projects.

Awesome Lists containing this project

README 

          



# 40Ants-CI - Github Workflow Generator



[![](https://github-actions.40ants.com/40ants/ci/matrix.svg)][de0b]



![](http://quickdocs.org/badge/ci.svg)



This is a small utility, which can generate GitHub workflows for Common Lisp

projects.



It generates workflow for running tests and building docs. These workflows

use [40ants/run-tests][8469] and [40ants/build-docs][b882]

actions and [`SBLint`][2f94] to check code for compilation errors.






## 40ANTS-CI ASDF System Details



* Description: A tool simplify continuous deployment for Common Lisp projects.

* Licence: `BSD`

* Author: Alexander Artemenko

* Homepage: [https://40ants.com/ci/][3f72]

* Source control: [GIT][e681]

* Depends on: [alexandria][8236], [serapeum][c41d], [str][ef7f], [yason][aba2]






## Reasons to Use



* This system hides all entrails related to caching.

* Includes a few ready to use job types.

* Custom job types can be defined and distributed as separate `ASDF` systems.

* You don't have to write `YAML` anymore!






## Quickstart



This system allows you to define workflows in the lisp code. The best way is to make these

definitions a part of your `ASDF` system. This way `40ants-ci` ([`1`][900b] [`2`][b171]) will be able to

automatically understand for which system it builds a workflow.



Each workflow consists of jobs and each job is a number of steps.



There are three predefine types of jobs and you can create your own. Predefined jobs

allows to reuse steps in multiple `CL` libraries.



In next examples, I'll presume you are writing code in a file which is the part

of the package inferred `ASDF` system `EXAMPLE/CI`. A file should have the following header:



```lisp

(defpackage #:example/ci

  (:use #:cl)

  (:import-from #:40ants-ci/workflow

                #:defworkflow)

  (:import-from #:40ants-ci/jobs/linter)

  (:import-from #:40ants-ci/jobs/run-tests)

  (:import-from #:40ants-ci/jobs/docs))

```




### Job Types






#### Autotag



This job is automates git tag placement on the commit where you have changed the ChangeLog.md.



This can be a useful to automate package deployment and releases. You update the changelog,

a job pushes a new git tag and the next action triggers on this tag and build a release.



Or you if you publish your library at Quicklisp distribution, then you can change

it's source type to the `latest-github-tag` to provide more stable releases to your

users. This way you commits into master will be ignored until you change the changelog and

git tag will be pushed. Here is an [example][1cec] how to setup this kind of quicklisp project source.



```lisp

(defworkflow release

  :on-push-to "master"

  :jobs ((40ants-ci/jobs/autotag:autotag)))

```




##### [function](9bde) `40ants-ci/jobs/autotag:autotag` &key (filename \*default-filename\*) (regex \*default-regex\*) (tag-prefix \*default-tag-prefix\*) (token-pattern \*default-token-pattern\*) env



Creates a job which will run autotagger to create a new git tag for release.






##### [class](a449) `40ants-ci/jobs/autotag:autotag` (job)



This type of the job created a git tag when finds a new tag in specified file.






#### Linter



The simplest job type is linter. It loads a



```lisp

(defworkflow linter

  :on-pull-request t

  :jobs ((40ants-ci/jobs/linter:linter)))

```

When you'll hit `C-c C-c` on this definition,

it will generate `.github/workflows/linter.yml` with following content:



```json

{

  "name": "LINTER",

  "on": {

    "pull_request": null

  },

  "jobs": {

    "linter": {

      "runs-on": "ubuntu-latest",

      "env": {

        "OS": "ubuntu-latest",

        "QUICKLISP_DIST": "quicklisp",

        "LISP": "sbcl-bin"

      },

      "steps": [

        {

          "name": "Checkout Code",

          "uses": "actions/checkout@v4"

        },

        {

          "name": "Setup Common Lisp Environment",

          "uses": "40ants/setup-lisp@v4",

          "with": {

            "asdf-system": "example"

          }

        },

        {

          "name": "Install SBLint",

          "run": "qlot exec ros install cxxxr/sblint",

          "shell": "bash"

        },

        {

          "name": "Run Linter",

          "run": "qlot exec sblint example.asd",

          "shell": "bash"

        }

      ]

    }

  }

}

```

Here you can see, a few steps in the job:



1. Checkout the code.

2. Install Roswell & Qlot using [40ants/setup-lisp][8de1] action.

3. Install [`SBLint`][2f94].

4. Run linter for `example.asd`.



Another interesting thing is that this workflow automatically uses `ubuntu-latest` `OS`,

`Quicklisp` and `sbcl-bin` Lisp implementation. Later I'll show you how to redefine these settings.






##### [class](d7f2) `40ants-ci/jobs/linter:linter` (lisp-job)






#### Critic



This job is similar to linter, but instead of `SBL`int it runs

[Lisp Critic][2100].



Lisp Critic is a program which advices how to make you Common Lisp code more

idiomatic, readable and performant. Also, sometimes it might catch logical

errors in the code.



Here is how you can add this job type in your workflow:



```lisp

(defworkflow ci

  :on-pull-request t

  :jobs ((40ants-ci/jobs/critic:critic)))

```

Also, you might combine this job together with others, for example,

with linter:



```lisp

(defworkflow ci

  :on-pull-request t

  :jobs ((40ants-ci/jobs/linter:linter)

         (40ants-ci/jobs/critic:critic)))

```

and they will be executed in parallel. See docs on [`40ants-ci/jobs/critic:critic`][484a] function

to learn about supported arguments.






#### Running Tests



Another interesting job type is `40ants-ci/jobs/run-tests:run-tests` ([`1`][e35d] [`2`][6cb7]).



When using this job type, make sure, your system

runs tests on `(ASDF:TEST-SYSTEM :system-name)` call

and signals error if something went wrong.



```lisp



(defworkflow ci

  :on-push-to "master"

  :by-cron "0 10 * * 1"

  :on-pull-request t

  :jobs ((40ants-ci/jobs/run-tests:run-tests

          :coverage t)))

```

Here I've added a few options to the workflow:



* `by-cron` - sets a schedule.

* `on-push-to` - defines a branch or branches to track.



It will generate `.github/workflows/ci.yml` with following content:



```json

{

  "name": "CI",

  "on": {

    "push": {

      "branches": [

        "master"

      ]

    },

    "pull_request": null,

    "schedule": [

      {

        "cron": "0 10 * * 1"

      }

    ]

  },

  "jobs": {



    "run-tests": {

      "runs-on": "ubuntu-latest",

      "env": {

        "OS": "ubuntu-latest",

        "QUICKLISP_DIST": "quicklisp",

        "LISP": "sbcl-bin"

      },

      "steps": [

        {

          "name": "Checkout Code",

          "uses": "actions/checkout@v4"

        },

        {

          "name": "Setup Common Lisp Environment",

          "uses": "40ants/setup-lisp@v4",

          "with": {

            "asdf-system": "example"

          }

        },

        {

          "name": "Run Tests",

          "uses": "40ants/run-tests@v2",

          "with": {

            "asdf-system": "example",

            "coveralls-token": "${{ secrets.github_token }}"

          }

        }

      ]

    }

  }

}

```

The result is similar to the workflow generated for Linter,

but uses [40ants/setup-lisp][59d7] action

at the final step.



Also, I've passed an option `:coverage t` to the job. Thus coverage

report will be uploaded to [Coveralls.io][b60c] automatically.






##### Defining a test Matrix



Lisp has many implementations and can be used on multiple platforms. Thus

it is a good idea to test our software on many combinations of `OS` and lisp

implementations. Workflow generator makes this very easy.



Here is an example of workflow definition with three dimentional matrix.

It not only tests a library under different lisps and `OS`, but also checks

if it works with the latest Quicklisp and Ultralisp distributions:



```lisp

(defworkflow ci

  :on-pull-request t

  :jobs ((run-tests

          :os ("ubuntu-latest"

               "macos-latest")

          :quicklisp ("quicklisp"

                      "ultralisp")

          :lisp ("sbcl-bin"

                 "ccl-bin"

                 "allegro"

                 "clisp"

                 "cmucl")

          :exclude (;; Seems allegro is does not support 64bit OSX.

                    ;; Unable to install it using Roswell:

                    ;; alisp is not executable. Missing 32bit glibc?

                    (:os "macos-latest" :lisp "allegro")))))

```




##### Multiple jobs



Besides a build matrix, you might specify a multiple jobs of the same type,

but with different parameters:



```lisp

(defworkflow ci

  :on-push-to "master"

  :on-pull-request t

  :jobs ((run-tests

          :lisp "sbcl-bin")

         (run-tests

          :lisp "ccl-bin")

         (run-tests

          :lisp "allegro")))

```

This will generate a workflow with three jobs: "run-tests", "run-tests-2" and "run-tests-3".



Meaningful names might be specified as well:



```lisp

(defworkflow ci

  :on-push-to "master"

  :on-pull-request t

  :jobs ((run-tests

          :name "test-on-sbcl"

          :lisp "sbcl-bin")

         (run-tests

          :name "test-on-ccl"

          :lisp "ccl-bin")

         (run-tests

          :name "test-on-allegro"

          :lisp "allegro")))

```

Here is how these jobs will look like in the GitHub interface:



![](https://user-images.githubusercontent.com/24827/151619261-2d49e2a6-bc5c-42db-aec5-674d9229a1b0.png)






#### Building Docs



Third predefined job type is `40ants-ci/jobs/docs:build-docs` ([`1`][13b8] [`2`][1ddb]).

It uses [40ants/build-docs][613f]

action and will work only if your `ASDF` system uses a documentation builder supported by

[40ants/docs-builder][f2be].



To build docs on every push to master, just use this code:



```lisp



(defworkflow docs

  :on-push-to "master"

  :jobs ((40ants-ci/jobs/docs:build-docs)))

```

It will generate `.github/workflows/docs.yml` with following content:



```json



{

  "name": "DOCS",

  "on": {

    "push": {

      "branches": [

        "master"

      ]

    }

  },

  "jobs": {

    "build-docs": {

      "runs-on": "ubuntu-latest",

      "env": {

        "OS": "ubuntu-latest",

        "QUICKLISP_DIST": "quicklisp",

        "LISP": "sbcl-bin"

      },

      "steps": [

        {

          "name": "Checkout Code",

          "uses": "actions/checkout@v4"

        },

        {

          "name": "Setup Common Lisp Environment",

          "uses": "40ants/setup-lisp@v4",

          "with": {

            "asdf-system": "example",

            "qlfile-template": ""

          }

        },

        {

          "name": "Build Docs",

          "uses": "40ants/build-docs@v1",

          "with": {

            "asdf-system": "example"

          }

        }

      ]

    }

  }

}

```




### Caching



To significantly speed up our tests, we can cache installed Roswell,

Qlot and Common Lisp fasl files.



To accomplish this task, you don't need to dig into GitHub's docs anymore!

Just add one line `:cache t` to your workflow definition:



```lisp

(defworkflow docs

  :on-push-to "master"

  :cache t

  :jobs ((40ants-ci/jobs/docs:build-docs)))

```

Here is the diff of the generated workflow file. It shows steps, added automatically:



```diff

modified   .github/workflows/docs.yml

@@ -20,13 +20,40 @@

           "name": "Checkout Code",

           "uses": "actions/checkout@v4"

         },

+        {

+          "name": "Grant All Perms to Make Cache Restoring Possible",

+          "run": "sudo mkdir -p /usr/local/etc/roswell\n                 sudo chown \"${USER}\" /usr/local/etc/roswell\n                 # Here the ros binary will be restored:\n                 sudo chown \"${USER}\" /usr/local/bin",

+          "shell": "bash"

+        },

+        {

+          "name": "Get Current Month",

+          "id": "current-month",

+          "run": "echo \"::set-output name=value::$(date -u \"+%Y-%m\")\"",

+          "shell": "bash"

+        },

+        {

+          "name": "Cache Roswell Setup",

+          "id": "cache",

+          "uses": "actions/cache@v3",

+          "with": {

+            "path": "qlfile\n                           qlfile.lock\n                           /usr/local/bin/ros\n                           ~/.cache/common-lisp/\n                           ~/.roswell\n                           /usr/local/etc/roswell\n                           .qlot",

+            "key": "${{ steps.current-month.outputs.value }}-${{ env.cache-name }}-ubuntu-latest-quicklisp-sbcl-bin-${{ hashFiles('qlfile.lock') }}"

+          }

+        },

+        {

+          "name": "Restore Path To Cached Files",

+          "run": "echo $HOME/.roswell/bin >> $GITHUB_PATH\n                 echo .qlot/bin >> $GITHUB_PATH",

+          "shell": "bash",

+          "if": "steps.cache.outputs.cache-hit == 'true'"

+        },

         {

           "name": "Setup Common Lisp Environment",

           "uses": "40ants/setup-lisp@v4",

           "with": {

             "asdf-system": "40ants-ci",

             "qlfile-template": ""

-          }

+          },

+          "if": "steps.cache.outputs.cache-hit != 'true'"

         },

         {

```




### Adding env variables



You can specify additional environment variables on any level of the GitHub workflow: for workflow itself, for a job or for a step.



To specify env for workflow or a job, just add an `ENV` argument with alist or plist value like this:



```lisp

(defworkflow release

  :on-push-to "master"

  :env (:github-token "${{ secrets.autotag_token }}")

  :jobs ((40ants-ci/jobs/autotag:autotag)))

```

or as alist:



```lisp

(defworkflow release

  :on-push-to "master"

  :env (("github_token" . "${{ secrets.autotag_token }}"))

  :jobs ((40ants-ci/jobs/autotag:autotag)))

```

or for the job itself:



```lisp

(defworkflow release

  :on-push-to "master"

  :jobs ((40ants-ci/jobs/autotag:autotag

           :env (:github-token "${{ secrets.autotag_token }}"))))

```

the same way it can be specified on a custom step:



```lisp

(40ants-ci/steps/sh:sh "Custom env-var example"

                       "echo $CUSTOM_VAR"

                       :env (:custom-var "Hello world!"))

```

Note - environment variable names are always transformed to uppercase and dashes are replaced with underscores.






### Running custom steps



Sometimes you might need to install custom system packages or do something before the job will finish. To accomplish

these task you can provide custom steps using `BEFORE-STEPS` argument or `AFTER-STEPS` argument.



Here is an example where we are installing system package libunaq1-dev before running the testsuite:



```lisp

(defparameter *required-steps*

  (list (sh "Install libunac"

            "sudo apt-get install -y libunac1-dev")))



(defworkflow ci

  :on-pull-request t

  :cache t

  :jobs ((run-tests

          :steps-before *required-steps*

          :asdf-system "my-asdf-system")))

```




## Details



`TODO`: I have to write a few chapters with details on additional job's parameters

and a way how to create new job types.



But for now, I want to show a small example, how to define a workflow with a

job which takes care about lisp installation and then calls a custom step:



```lisp

(defworkflow ci

  :on-push-to "master"

  :by-cron "0 10 * * 1"

  :on-pull-request t

  :cache t

  :jobs ((40ants-ci/jobs/lisp-job:lisp-job :name "check-ros-config"

                                           :lisp "ccl-bin"

                                           :steps ((40ants-ci/steps/sh:sh "Show Roswell Config"

                                                                          "ros config")))))

```

Here we are using the class [`40ants-ci/jobs/lisp-job:lisp-job`][2f4c] which is base for most classes in this `ASDF` system

and pass a custom `40ants-ci/steps/sh:sh` ([`1`][4d70] [`2`][0f59]) step to it. This step will be called after the repostory checkout and `CCL-BIN` lisp installation.

so, thus when this step will run `ros config` command, it will output something like that:



```

asdf.version=3.3.5.3

ccl-bin.version=1.12.2

setup.time=3918000017

sbcl-bin.version=2.4.1

default.lisp=ccl-bin



Possible subcommands:

set

show

```

Pay attention to the `NAME` argument of [`40ants-ci/jobs/lisp-job:lisp-job`][2f4c] class. If you omit it, then default "lisp-job" name will be used.






## API






### 40ANTS-CI






#### [package](ce4f) `40ants-ci`






#### Functions






##### [function](6f89) `40ants-ci:generate` system &key path



Generates GitHub workflow for given `ASDF` system.



This function searches workflow definitions in all packages

of the given `ASDF` system.



If `PATH` argument is not given, workflow files will be written

to .github/workflow/ relarive to the `SYSTEM`.






### 40ANTS-CI/GITHUB






#### [package](b5b6) `40ants-ci/github`






#### Generics






##### [generic-function](0b0f) `40ants-ci/github:generate` obj path






##### [generic-function](cc9b) `40ants-ci/github:prepare-data` obj






#### Variables






##### [variable](6ea3) `40ants-ci/vars:*current-system*` -unbound-



When workflow is generated for `ASDF` system, this variable will contain a primary `ASDF` system.






### 40ANTS-CI/JOBS/AUTOTAG






#### [package](634b) `40ants-ci/jobs/autotag`






#### Classes






##### AUTOTAG






###### [class](a449) `40ants-ci/jobs/autotag:autotag` (job)



This type of the job created a git tag when finds a new tag in specified file.



**Readers**






###### [reader](fc02) `40ants-ci/jobs/autotag:filename` (autotag) (:filename = \*default-filename\*)



File where to search for version numbers.






###### [reader](90d5) `40ants-ci/jobs/autotag:regex` (autotag) (:regex = \*default-regex\*)



Regexp used to extract version numbers.






###### [reader](211b) `40ants-ci/jobs/autotag:tag-prefix` (autotag) (:tag-prefix = \*default-tag-prefix\*)



Tag prefix.






###### [reader](66f4) `40ants-ci/jobs/autotag:token-pattern` (autotag) (:token-pattern = \*default-token-pattern\*)



Auth token pattern.






#### Functions






##### [function](9bde) `40ants-ci/jobs/autotag:autotag` &key (filename \*default-filename\*) (regex \*default-regex\*) (tag-prefix \*default-tag-prefix\*) (token-pattern \*default-token-pattern\*) env



Creates a job which will run autotagger to create a new git tag for release.






### 40ANTS-CI/JOBS/CRITIC






#### [package](bca1) `40ants-ci/jobs/critic`






#### Classes






##### CRITIC






###### [class](7d77) `40ants-ci/jobs/critic:critic` (lisp-job)



**Readers**






###### [reader](432e) `40ants-ci/jobs/critic:asdf-systems` (critic) (:asdf-systems)



Critic can validate more than one system, but for the base class we need provide only one.






###### [reader](add0) `40ants-ci/jobs/critic:ignore-critiques` (critic) (:ignore-critiques)



A list strigns with names of critiques to ignore.






#### Functions






##### [function](7fa5) `40ants-ci/jobs/critic:critic` &key asdf-systems asdf-version ignore-critiques env



Creates a job which will run Lisp Critic for given `ASDF` systems.



If argument `ASDF-SYSTEMS` is `NIL`, it will use `ASDF` system

to which current lisp file is belong.



You may also provide `ASDF-VERSION` argument. It should be

a string. By default, the latest `ASDF` version will be used.






### 40ANTS-CI/JOBS/DOCS






#### [package](9225) `40ants-ci/jobs/docs`






#### Classes






##### BUILD-DOCS






###### [class](b7e9) `40ants-ci/jobs/docs:build-docs` (lisp-job)



Builds documentation and uploads it to GitHub using ["40ants/build-docs" github action][613f].



**Readers**






###### [reader](1b33) `40ants-ci/jobs/docs:error-on-warnings` (build-docs) (:error-on-warnings = t)






#### Functions






##### [function](ab61) `40ants-ci/jobs/docs:build-docs` &rest args &key (error-on-warnings t) os permissions exclude env steps steps-before steps-after roswell-version asdf-version qlot-version quicklisp lisp asdf-system qlfile checkout-submodules dynamic-space-size



Creates a job of class [`build-docs`][1ddb].






### 40ANTS-CI/JOBS/JOB






#### [package](7574) `40ants-ci/jobs/job`






#### Classes






##### JOB






###### [class](6c99) `40ants-ci/jobs/job:job` ()



**Readers**






###### [reader](61ff) `40ants-ci/jobs/job:exclude` (job) (:exclude = nil)



A list of plists denoting matrix combinations to be excluded.






###### [reader](00d8) `40ants-ci/jobs/job:explicit-steps` (job) (:steps = nil)



This slot holds steps given as a `STEPS` argument to a job constructor. Depending on a job class, it might add additional steps around these explicit steps.






###### [reader](174e) `40ants-ci/jobs/job:job-env` (job) (:env = nil)



An alist of environment variables and their values to be added on job level. Values are evaluated in runtime.






###### [reader](cd97) `40ants-ci/jobs/job:name` (job) (:name)



If this name was not given in constructor, then name will be lowercased name of the job class.






###### [reader](3e5d) `40ants-ci/jobs/job:os` (job) (:OS = "ubuntu-latest")






###### [reader](9a17) `40ants-ci/jobs/job:permissions` (job) (:permissions = nil)



A plist of permissions need for running the job.



These permissions will be bound to `secrets.GITHUB_TOKEN` variable.

Use default-initargs to override permissions in subclasses:



```lisp

(:default-initargs

 :permissions '(:content "write"))

```




###### [reader](b9d6) `40ants-ci/jobs/job:steps-after` (job) (:steps-after = nil)



This slot holds steps given as a `STEPS-AFTER` argument to a job constructor. These steps will be appended to steps returned by the [`job`][17c5] class.






###### [reader](db8a) `40ants-ci/jobs/job:steps-before` (job) (:steps-before = nil)



This slot holds steps given as a `STEPS-BEFORE` argument to a job constructor. These steps will be prepended to steps returned by the [`job`][17c5] class.






#### Generics






##### [generic-function](b017) `40ants-ci/jobs/job:make-env` job






##### [generic-function](6b50) `40ants-ci/jobs/job:make-matrix` job






##### [generic-function](3ecb) `40ants-ci/jobs/job:make-permissions` job



Should return an alist with mapping from string to string where keys are scopes and values are permission names. Default method generates this alist from the plist of job's "permissions" slot.






##### [generic-function](8fe1) `40ants-ci/jobs/job:steps` job






##### [generic-function](3f8a) `40ants-ci/jobs/job:use-matrix-p` job






### 40ANTS-CI/JOBS/LINTER






#### [package](5b2f) `40ants-ci/jobs/linter`






#### Classes






##### LINTER






###### [class](d7f2) `40ants-ci/jobs/linter:linter` (lisp-job)



**Readers**






###### [reader](8331) `40ants-ci/jobs/linter:asdf-systems` (linter) (:asdf-systems = nil)



Linter can validate more than one system, but for the base class we need provide only one.






###### [reader](9c44) `40ants-ci/jobs/linter:check-imports` (linter) (:check-imports = nil)



Linter will check for missing or unused imports of package-inferred systems.






#### Functions






##### [function](366b) `40ants-ci/jobs/linter:linter` &rest args &key asdf-systems check-imports os permissions exclude env steps steps-before steps-after roswell-version asdf-version qlot-version quicklisp lisp qlfile checkout-submodules dynamic-space-size



Creates a job which will run `SBL`int for given `ASDF` systems.



If no `ASD` files given, it will use all `ASD` files from

the current `ASDF` system.






### 40ANTS-CI/JOBS/LISP-JOB






#### [package](3114) `40ants-ci/jobs/lisp-job`






#### Classes






##### LISP-JOB






###### [class](b1f2) `40ants-ci/jobs/lisp-job:lisp-job` (job)



This job checkouts the sources, installs Roswell and Qlot. Also, it caches results between runs.



**Readers**






###### [reader](0a70) `40ants-ci/jobs/lisp-job:asdf-system` (lisp-job) (:asdf-system = nil)






###### [reader](0f71) `40ants-ci/jobs/lisp-job:asdf-version` (lisp-job) (:asdf-version = nil)



`ASDF` version to use when setting up Lisp environment. If `NIL`, then the latest will be used.






###### [reader](d88c) `40ants-ci/jobs/lisp-job:checkout-submodules` (lisp-job) (:checkout-submodules = nil)



If this flag is true, then we will command actions/checkout action to checkout submodules.






###### [reader](743d) `40ants-ci/jobs/lisp-job:dynamic-space-size` (lisp-job) (:dynamic-space-size = nil)



Dynamic space size for `SBCL`.






###### [reader](3315) `40ants-ci/jobs/lisp-job:lisp` (lisp-job) (:LISP = "sbcl-bin")






###### [reader](ebec) `40ants-ci/jobs/lisp-job:qlfile` (lisp-job) (:qlfile = nil)






###### [reader](52dc) `40ants-ci/jobs/lisp-job:qlot-version` (lisp-job) (:qlot-version = nil)



Qlot version to use when setting up Lisp environment. If `NIL`, then will be used version, pinned in `setup-lisp` github action.






###### [reader](de61) `40ants-ci/jobs/lisp-job:quicklisp` (lisp-job) (:QUICKLISP = "quicklisp")






###### [reader](fd6f) `40ants-ci/jobs/lisp-job:roswell-version` (lisp-job) (:roswell-version = nil)



Roswell version to use when setting up Lisp environment. If `NIL`, then will be used version, pinned in `setup-lisp` github action.






### 40ANTS-CI/JOBS/RUN-TESTS






#### [package](3424) `40ants-ci/jobs/run-tests`






#### Classes






##### RUN-TESTS






###### [class](bacc) `40ants-ci/jobs/run-tests:run-tests` (lisp-job)



This job test runs tests for a given `ASDF` system.



**Readers**






###### [reader](ff89) `40ants-ci/jobs/run-tests:coverage` (run-tests) (:coverage = nil)






###### [reader](ebf5) `40ants-ci/jobs/run-tests:custom` (run-tests) (:custom = nil)






#### Functions






##### [function](7f85) `40ants-ci/jobs/run-tests:run-tests` &rest rest &key coverage custom os permissions steps steps-before steps-after env roswell-version asdf-version qlot-version lisp exclude qlfile quicklisp asdf-system checkout-submodules dynamic-space-size



Creates a job step of class [`run-tests`][6cb7].






### 40ANTS-CI/STEPS/ACTION






#### [package](a457) `40ants-ci/steps/action`






#### Classes






##### ACTION






###### [class](3516) `40ants-ci/steps/action:action` (step)



**Readers**






###### [reader](3c04) `40ants-ci/steps/action:action-args` (action) (:args)



A plist to be passed as "with" dictionary to the action.






###### [reader](f8ab) `40ants-ci/steps/action:uses` (action) (:uses)






#### Functions






##### [function](a671) `40ants-ci/steps/action:action` name uses &rest args &key id if env &allow-other-keys






### 40ANTS-CI/STEPS/SH






#### [package](8657) `40ants-ci/steps/sh`






#### Classes






##### SH






###### [class](01f9) `40ants-ci/steps/sh:sh` (step)



**Readers**






###### [reader](6a36) `40ants-ci/steps/sh:command` (sh) (:command)






###### [reader](73c7) `40ants-ci/steps/sh:shell` (sh) (:shell = \*default-shell\*)






#### Functions






##### [function](3b5c) `40ants-ci/steps/sh:sh` name command &key id if (shell \*default-shell\*) env






#### Macros






##### [macro](9ce9) `40ants-ci/steps/sh:sections` &body body



Returns a string with a bash script where some parts are grouped.



In this example we have 3 sections:



```lisp

(sections

      ("Help Argument"

       "qlot exec cl-info --help")

      ("Version Argument"

       "qlot exec cl-info --version")

      ("Lisp Systems Info"

       "qlot exec cl-info"

       "qlot exec cl-info cl-info defmain"))

```

It will be compiled into:



```bash

echo ::group::Help Argument

qlot exec cl-info --help

echo ::endgroup::

echo ::group::Version Argument

qlot exec cl-info --version

echo ::endgroup::

echo ::group::Lisp Systems Info

qlot exec cl-info

qlot exec cl-info cl-info defmain

echo ::endgroup::

```




### 40ANTS-CI/STEPS/STEP






#### [package](7383) `40ants-ci/steps/step`






#### Classes






##### STEP






###### [class](07c0) `40ants-ci/steps/step:step` ()



**Readers**






###### [reader](693b) `40ants-ci/steps/step:env` (step) (:env = nil)



An alist of environment variables.






###### [reader](bbe6) `40ants-ci/steps/step:step-id` (step) (:id = nil)






###### [reader](3207) `40ants-ci/steps/step:step-if` (step) (:if = nil)






###### [reader](9c1f) `40ants-ci/steps/step:step-name` (step) (:name = nil)






### 40ANTS-CI/UTILS






#### [package](73f9) `40ants-ci/utils`






#### Generics






##### [generic-function](f910) `40ants-ci/utils:system-packages` system



Returns a list of packages created by `ASDF` system.



Default implementation returns a package having the same name as a system

and all packages matched to package-inferred subsystems:



```

CL-USER> (docs-builder/utils:system-packages :docs-builder)

(#

 #

 #

 #

 #

 #

 #

 #)

```




#### Functions






##### [function](ada0) `40ants-ci/utils:alistp` list



Test wheather `LIST` argument is a properly formed alist.



In this library, alist has always a string as a key.

Because we need them to have this form to serialize

to `JSON` propertly.



(alistp '(("cron" . "0 10 * * 1"))) -> T

(alistp '((("cron" . "0 10 * * 1")))) -> `NIL`






##### [function](9956) `40ants-ci/utils:current-system-name`






##### [function](2560) `40ants-ci/utils:dedent` text



Removes common leading whitespace from each string.



A few examples:



```

(dedent "Hello

          World

          and all Lispers!")



"Hello

World

and all Lispers!"

```

```

(dedent "

    Hello

    World

    and all Lispers!")



"Hello

World

and all Lispers!"

```

```

(dedent "This is a code:



              (symbol-name :hello-world)



          it will output HELLO-WORLD.")



"This is a code:



    (symbol-name :hello-world)



it will output HELLO-WORLD."

```




##### [function](bb81) `40ants-ci/utils:ensure-list-of-plists` data






##### [function](102f) `40ants-ci/utils:ensure-primary-system` system






##### [function](8324) `40ants-ci/utils:make-github-workflows-path` system






##### [function](f1d3) `40ants-ci/utils:plist-to-alist` plist &key (string-keys t) (lowercase t)



Make an alist from a plist `PLIST`.



By default, transforms keys to lowercased strings






##### [function](3a17) `40ants-ci/utils:plistp` list



Test wheather `LIST` is a properly formed plist.






##### [function](2598) `40ants-ci/utils:single` list



Test wheather `LIST` contains exactly 1 element.






##### [function](a94a) `40ants-ci/utils:to-json` data






### 40ANTS-CI/VARS






#### [package](e959) `40ants-ci/vars`






#### Variables






##### [variable](6ea3) `40ants-ci/vars:*current-system*` -unbound-



When workflow is generated for `ASDF` system, this variable will contain a primary `ASDF` system.






##### [variable](2c71) `40ants-ci/vars:*use-cache*` nil



Workflow will set this variable when preparing the data or `YAML` generation.






### 40ANTS-CI/WORKFLOW






#### [package](d34b) `40ants-ci/workflow`






#### Classes






##### WORKFLOW






###### [class](e71a) `40ants-ci/workflow:workflow` ()



**Readers**






###### [reader](c940) `40ants-ci/workflow:by-cron` (workflow) (:by-cron = "0 10 \* \* 1")






###### [reader](c78a) `40ants-ci/workflow:cache-p` (workflow) (:cache = t)






###### [reader](99bf) `40ants-ci/workflow:jobs` (workflow) (:jobs = nil)






###### [reader](c215) `40ants-ci/workflow:name` (workflow) (:name)






###### [reader](2d6d) `40ants-ci/workflow:on-pull-request` (workflow) (:on-pull-request = t)






###### [reader](84ae) `40ants-ci/workflow:on-push-to` (workflow) (:ON-PUSH-TO = "master")






###### [reader](4a15) `40ants-ci/workflow:workflow-env` (workflow) (:env = nil)



An alist of environment variables and their values to be added on workflow level. Values are evaluated in runtime.






#### Macros






##### [macro](4459) `40ants-ci/workflow:defworkflow` name &key on-push-to by-cron on-pull-request cache env jobs



[2100]: https://40ants.com/40ants-critic

[b882]: https://40ants.com/build-doc

[613f]: https://40ants.com/build-docs/

[3f72]: https://40ants.com/ci/

[900b]: https://40ants.com/ci/#x-28-23A-28-289-29-20BASE-CHAR-20-2E-20-2240ANTS-CI-22-29-20PACKAGE-29

[b171]: https://40ants.com/ci/#x-28-23A-28-289-29-20BASE-CHAR-20-2E-20-2240ants-ci-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29

[484a]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FCRITIC-3ACRITIC-20FUNCTION-29

[1ddb]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FDOCS-3ABUILD-DOCS-20CLASS-29

[13b8]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FDOCS-3ABUILD-DOCS-20FUNCTION-29

[17c5]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FJOB-3AJOB-20CLASS-29

[2f4c]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FLISP-JOB-3ALISP-JOB-20CLASS-29

[6cb7]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FRUN-TESTS-3ARUN-TESTS-20CLASS-29

[e35d]: https://40ants.com/ci/#x-2840ANTS-CI-2FJOBS-2FRUN-TESTS-3ARUN-TESTS-20FUNCTION-29

[0f59]: https://40ants.com/ci/#x-2840ANTS-CI-2FSTEPS-2FSH-3ASH-20CLASS-29

[4d70]: https://40ants.com/ci/#x-2840ANTS-CI-2FSTEPS-2FSH-3ASH-20FUNCTION-29

[f2be]: https://40ants.com/docs-builder/

[8469]: https://40ants.com/run-tests

[59d7]: https://40ants.com/run-tests/

[8de1]: https://40ants.com/setup-lisp/

[b60c]: https://coveralls.io/

[e681]: https://github.com/40ants/ci

[de0b]: https://github.com/40ants/ci/actions

[ce4f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/core.lisp#L1

[6f89]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/core.lisp#L9

[b5b6]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/github.lisp#L1

[0b0f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/github.lisp#L16

[cc9b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/github.lisp#L36

[634b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L1

[a449]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L23

[fc02]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L24

[90d5]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L29

[211b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L34

[66f4]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L39

[9bde]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/autotag.lisp#L49

[bca1]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/critic.lisp#L1

[7d77]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/critic.lisp#L14

[432e]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/critic.lisp#L16

[add0]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/critic.lisp#L19

[7fa5]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/critic.lisp#L24

[9225]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/docs.lisp#L1

[b7e9]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/docs.lisp#L15

[1b33]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/docs.lisp#L16

[ab61]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/docs.lisp#L22

[7574]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L1

[8fe1]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L100

[3f8a]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L117

[6b50]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L122

[b017]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L133

[3ecb]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L162

[6c99]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L31

[cd97]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L32

[3e5d]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L35

[61ff]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L38

[174e]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L42

[00d8]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L47

[db8a]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L51

[b9d6]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L55

[9a17]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/job.lisp#L59

[5b2f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/linter.lisp#L1

[d7f2]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/linter.lisp#L16

[8331]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/linter.lisp#L17

[9c44]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/linter.lisp#L22

[366b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/linter.lisp#L35

[3114]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L1

[b1f2]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L30

[de61]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L31

[3315]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L34

[ebec]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L37

[0a70]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L40

[0f71]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L44

[fd6f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L49

[743d]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L54

[52dc]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L59

[d88c]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/lisp-job.lisp#L64

[3424]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/run-tests.lisp#L1

[bacc]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/run-tests.lisp#L19

[ff89]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/run-tests.lisp#L20

[ebf5]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/run-tests.lisp#L23

[7f85]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/jobs/run-tests.lisp#L29

[a457]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/action.lisp#L1

[3516]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/action.lisp#L13

[f8ab]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/action.lisp#L14

[3c04]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/action.lisp#L16

[a671]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/action.lisp#L22

[8657]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L1

[01f9]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L17

[6a36]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L18

[73c7]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L20

[3b5c]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L26

[9ce9]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/sh.lisp#L42

[7383]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L1

[07c0]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L19

[bbe6]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L20

[9c1f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L23

[693b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L26

[3207]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/steps/step.lisp#L31

[73f9]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L1

[2598]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L154

[3a17]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L159

[ada0]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L169

[bb81]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L185

[f1d3]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L197

[8324]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L215

[a94a]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L232

[102f]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L25

[f910]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L31

[9956]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L70

[2560]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/utils.lisp#L85

[e959]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/vars.lisp#L1

[2c71]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/vars.lisp#L14

[6ea3]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/vars.lisp#L9

[d34b]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L1

[4459]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L137

[e71a]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L32

[c215]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L33

[84ae]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L35

[2d6d]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L38

[c940]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L41

[c78a]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L44

[4a15]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L47

[99bf]: https://github.com/40ants/ci/blob/9f7233f440f18654d67383fde0db9996df5af70a/src/workflow.lisp#L52

[2f94]: https://github.com/cxxxr/sblint

[1cec]: https://github.com/quicklisp/quicklisp-projects/blob/ee133271c81caf5d8bbf8cef3054544ff47b64c6/projects/alexa/source.txt

[8236]: https://quickdocs.org/alexandria

[c41d]: https://quickdocs.org/serapeum

[ef7f]: https://quickdocs.org/str

[aba2]: https://quickdocs.org/yason



* * *

###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]