The ci-utils Reference Manual

This is the ci-utils Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:36:16 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 ci-utils

A set of tools for using CI platforms

Author

Neil Lindquist <>

License

MIT

Version

1.0.0

Dependency

ci-utils-features (system).

Source

ci-utils.asd.

Child Component

ci-utils.lisp (file).


2.2 ci-utils-features

An internal system that loads the features before loading the rest of the systems

Author

Neil Lindquist <>

License

MIT

Source

ci-utils-features.asd.

Child Component

features.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 ci-utils/ci-utils.asd

Source

ci-utils.asd.

Parent Component

ci-utils (system).

ASDF Systems

ci-utils.


3.1.2 ci-utils-features/ci-utils-features.asd

Source

ci-utils-features.asd.

Parent Component

ci-utils-features (system).

ASDF Systems

ci-utils-features.


3.1.3 ci-utils/ci-utils.lisp

Source

ci-utils.asd.

Parent Component

ci-utils (system).

Packages

ci-utils.

Public Interface

3.1.4 ci-utils-features/features.lisp

Source

ci-utils-features.asd.

Parent Component

ci-utils-features (system).


4 Packages

Packages are listed by definition order.


4.1 ci-utils

Source

ci-utils.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: branch ()

Returns the name of the branch the build is from, or ‘NIL‘ for unknown and non-ci platforms.

Package

ci-utils.

Source

ci-utils.lisp.

Function: build-dir ()

Returns the directory that the code was copied into. When not on a known CI platform, the current working directory is returned.

Package

ci-utils.

Source

ci-utils.lisp.

Function: build-id ()

Returns the build id for the given platform. ‘NIL‘ is returned on unsupported platforms.

Package

ci-utils.

Source

ci-utils.lisp.

Function: cip ()

Whether lisp is running on a CI platform.

Package

ci-utils.

Source

ci-utils.lisp.

Function: commit-id ()

Returns the ID of the current commit. For git projects, this is the commit’s SHA. ‘NIL‘ is returned on unsupported platforms.

Package

ci-utils.

Source

ci-utils.lisp.

Function: platform ()

Returns the current CI platform. When on a non-ci platform, nil is returned. The following is the symbols for supported platforms

| Platform | Symbol Name | |:——————-:|:———————-:|
| Travis CI | ‘:TRAVIS-CI‘ |
| Circle CI | ‘:CIRCLECI‘ |
| Appveyor | ‘:APPVEYOR‘ |
| GitLab CI | ‘:GITLAB-CI‘ |
| Bitbucket Pipelines | ‘:BITBUCKET-PIPELINES‘ |
| Azure Pipelines | ‘:AZURE-PIPELINES‘ |
| Github Actions | ‘:GITHUB-ACTIONS‘ |
| unknown ci systems | ‘:UNKNOWN-CI‘ |

Package

ci-utils.

Source

ci-utils.lisp.

Function: pull-request-p ()

Returns whether the build is for a pull/merge request. Unknown and non-ci platforms are considered to not be pull requests. A string containing the pull request number is returned for pull requests

Package

ci-utils.

Source

ci-utils.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables