Liking cljdoc? Tell your friends :D

monkey.ci.artifacts

Functionality for saving/restoring artifacts. This is similar to caches, but where caches are used between the same jobs in different builds, artifacts are used for different jobs in the same build. Artifacts can also be exposed to the outside world.

Functionality for saving/restoring artifacts.  This is similar to caches, but
where caches are used between the same jobs in different builds, artifacts are
used for different jobs in the same build.  Artifacts can also be exposed to
the outside world.
raw docstring

monkey.ci.blob

Blob storage functionality, used to store and restore large files or entire directories.

Blob storage functionality, used to store and restore large files
or entire directories.
raw docstring

monkey.ci.build.api

Functions for invoking the script API.

Functions for invoking the script API.
raw docstring

monkey.ci.build.container

Functions to configure container images on a build step

Functions to configure container images on a build step
raw docstring

monkey.ci.build.core

Core build script functionality. This is used by build scripts to create the configuration which is then executed by the configured runner. Which runner is configured or active depends on the configuration of the MonkeyCI application that executes the script.

Core build script functionality.  This is used by build scripts to create
the configuration which is then executed by the configured runner.  Which
runner is configured or active depends on the configuration of the MonkeyCI
application that executes the script.
raw docstring

monkey.ci.build.spec

No vars found in this namespace.

monkey.ci.cache

Functionality for saving/restoring caches. This uses blobs.

Functionality for saving/restoring caches.  This uses blobs.
raw docstring

monkey.ci.config

Configuration functionality. This reads the application configuration from various sources, like environment vars or command-line args. The configuration is structured in a hierarchy and optionally some values are converted. Then this configuration is used to add any 'constructor functions', that are then used to create new functions to do some actual work. This allows us to change the behaviour of the application with configuration, but also makes it possible to inject dummy functions for testing purposes.

Configuration functionality.  This reads the application configuration from various
sources, like environment vars or command-line args.  The configuration is structured
in a hierarchy and optionally some values are converted.  Then this configuration is
used to add any 'constructor functions', that are then used to create new functions to
do some actual work.  This allows us to change the behaviour of the application with
configuration, but also makes it possible to inject dummy functions for testing 
purposes.
raw docstring

monkey.ci.containers

Generic functionality for running containers

Generic functionality for running containers
raw docstring

monkey.ci.containers.podman

Functions for running containers using Podman. We don't use the api here, because it requires a socket, which is not always available. Instead, we invoke the podman command as a child process and communicate with it using the standard i/o streams.

Functions for running containers using Podman.  We don't use the api here, because
it requires a socket, which is not always available.  Instead, we invoke the podman
command as a child process and communicate with it using the standard i/o streams.
raw docstring

monkey.ci.containers.promtail

Functions for configuring promtail containers. This is not a container driver, but a utility namespace that is in turn used when pushing build logs to Loki.

Functions for configuring promtail containers.  This is not a container driver, but
a utility namespace that is in turn used when pushing build logs to Loki.
raw docstring

monkey.ci.core

Core namespace for the Monkey CI app. This contains the entrypoint which processes the configuration. This configuration determines whether the application runs as a server, execute a single script, which type of runner is enabled, etc...

Core namespace for the Monkey CI app.  This contains the entrypoint which
processes the configuration.  This configuration determines whether the
application runs as a server, execute a single script, which type of runner
is enabled, etc...
raw docstring

monkey.ci.events.jms

Uses JMS (with bowerick) to connect to an event broker. Can also starts its own broker server, although this is mostly meant for development and testing purposes.

Uses JMS (with bowerick) to connect to an event broker.  Can also
starts its own broker server, although this is mostly meant for
development and testing purposes.
raw docstring

monkey.ci.events.manifold

Manifold-based implementation of event poster and receiver

Manifold-based implementation of event poster and receiver
raw docstring

monkey.ci.extensions

Functionality for working with script extensions. Extensions are a way for third party libraries to add functionality to scripts, that is easy to activate and can also be used in yaml-type scripts. You could of course also add regular functions to invoke, but this is not easy to use, especially when using container jobs. Extensions do this by registering themselves under a specific namespaced keyword. If this key is found in job properties, the associated extension code is executed. Extensions can be executed before or after a job (or both).

Functionality for working with script extensions.  Extensions are a way
for third party libraries to add functionality to scripts, that is easy
to activate and can also be used in yaml-type scripts.  You could of 
course also add regular functions to invoke, but this is not easy to
use, especially when using container jobs.  Extensions do this by registering
themselves under a specific namespaced keyword.  If this key is found in
job properties, the associated extension code is executed.  Extensions can
be executed before or after a job (or both).
raw docstring

monkey.ci.git

Clone and checkout git repos. This is mostly a wrapper for clj-jgit

Clone and checkout git repos.  This is mostly a wrapper for `clj-jgit`
raw docstring

monkey.ci.logging

Handles log configuration and how to process logs from a build script

Handles log configuration and how to process logs from a build script
raw docstring

monkey.ci.process

Process execution functions. Executes build scripts in a separate process, using clojure cli tools.

Process execution functions.  Executes build scripts in a separate process,
using clojure cli tools.
raw docstring

monkey.ci.protocols

Contains all (or most of) the protocols used in the app. This is useful to avoid circular dependencies.

Contains all (or most of) the protocols used in the app.  This is useful
to avoid circular dependencies.
raw docstring

monkey.ci.reporting

Provides functions for reporting output. This can be logging, or printing to stdout, or formatting as json, etc...

Provides functions for reporting output.  This can be logging, or printing
to stdout, or formatting as json, etc...
raw docstring

monkey.ci.reporting.print

Reporter that prints to the console using coloring.

Reporter that prints to the console using coloring.
raw docstring

monkey.ci.runners

Defines runner functionality. These depend on the application configuration. A runner is able to execute a build script.

Defines runner functionality.  These depend on the application configuration.
A runner is able to execute a build script.
raw docstring

monkey.ci.runtime

The runtime can be considered the 'live configuration'. It is created from the configuration, and is passed on to the application modules. The runtime provides the information (often in the form of functions) needed by the modules to perform work. This allows us to change application behaviour depending on configuration, but also when testing.

Thie namespace also provides some utility functions for working with the context. This is more stable than reading properties from the runtime directly.

The runtime can be considered the 'live configuration'.  It is created
from the configuration, and is passed on to the application modules.  The
runtime provides the information (often in the form of functions) needed
by the modules to perform work.  This allows us to change application 
behaviour depending on configuration, but also when testing.

Thie namespace also provides some utility functions for working with the
context.  This is more stable than reading properties from the runtime 
directly.
raw docstring

monkey.ci.spec.build

Spec definitions for build. The build object in the runtime and events that contain builds, scripts or jobs should conform to these specs.

Spec definitions for build.  The build object in the runtime and events that contain
builds, scripts or jobs should conform to these specs.
raw docstring

monkey.ci.spec.events

Spec definitions for events

Spec definitions for events
raw docstring

No vars found in this namespace.

monkey.ci.spec.extensions

No vars found in this namespace.

monkey.ci.storage.cached

Cached storage implementation. It wraps another storage and adds caching to it. This currently is a very naive implementation. It should be expanded with event processing, in case there are multiple replicas. Or we should replace it with a 'real' database.

Cached storage implementation.  It wraps another storage and adds caching to it.
This currently is a very naive implementation.  It should be expanded with event processing,
in case there are multiple replicas.  Or we should replace it with a 'real' database.
raw docstring

No vars found in this namespace.

monkey.ci.storage.file

File storage implementation. Useful for local or develop runs. It stores all information in local .edn files.

File storage implementation.  Useful for local or develop runs.  It stores all
information in local .edn files.
raw docstring

monkey.ci.web.script-api

API functionality that can be accessed by the build script. This can either be part of the public API, or exposed through a UDS from the build runner. The script API does not have security on its own, since the implementation will take care of this. The script API exposes an OpenAPI spec, which is then fetched by the script, so it knows which services are available.

API functionality that can be accessed by the build script.  This can either
be part of the public API, or exposed through a UDS from the build runner.  The
script API does not have security on its own, since the implementation will
take care of this.  The script API exposes an OpenAPI spec, which is then
fetched by the script, so it knows which services are available.
raw docstring

monkey.ci.workspace

No vars found in this namespace.

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close