monkey.ci.build.v2 — com.monkeyci/app 0.14.4

A group of functions written on top of the more low-level build functions, meant to improve writing build scripts. They should make the build scripts more intuitive, more readable. And, dare I say it, prettier?

The general intention is to provide functions for most purposes, without the user having to resort to using keywords and maps.

action-job clj

Declares an action job with id, action and options

action-job? clj

Checks if argument is an action job

added? clj

Checks if files have been added in this build using the given predicate, which can either be a regex, a string or a matcher function. Accepts one or two arguments: when given one argument, returns a function that accepts the context to check if the predicate matches. When given two arguments, accepts the context and the predicate.

artifact clj

(artifact id path)

Defines a new artifact with given id, located at given path. This can be passed to save-artifacts or restore-artifacts.

bash clj

(bash id & cmds)

Creates an action job that executes given command in a bash script

branch clj

Gets commit branch from the context.

build-id clj

Returns current build id

build-params clj

Retrieves parameters this build has access to

cache clj

Defines a cache with given id an path, that can be passed to caches

caches clj

(caches job & arts)

Configures the caches a job uses.

container-job clj

(container-job id & [opts])

Declares an container job with id and container options

container-job? clj

Checks if argument is an container job

dependencies clj

Gets the configured dependencies of a job

depends-on clj

(depends-on job & deps)

Adds dependencies to the given job. Does not overwrite existing dependencies.

env clj

(env job)

(env job e)

Gets or sets environment vars for the job

error clj

Same as failure

failed clj

Same as failure

failure clj

Indicates the job has failed

image clj

(image job)

(image job img)

Gets or sets container image

job-id clj

Gets the id of the given job

main-branch clj

Gets configured main branch from the build.

main-branch? clj

Checks if the build branch is the configured main branch.

modified? clj

Checks if files have been modified in this build using the given predicate, which can either be a regex, a string or a matcher function. Similar to added?.

params clj

Shorthand for build-params

removed? clj

Checks if files have been removed in this build using the given predicate, which can either be a regex, a string or a matcher function. Similar to added?.

restore-artifacts clj

(restore-artifacts job & arts)

Configures the artifacts to restore on a job.

save-artifacts clj

(save-artifacts job & arts)

Configures the artifacts to save on a job.

script clj

(script job)

(script job script)

Gets or sets container job script

shell clj

Same as bash

skipped clj

Indicates the job was intentionally skipped

success clj

Indicates the job was successful

tag clj

Gets commit tag (if any) from the context.

touched? clj

Checks if files have been touched in this build using the given predicate, which can either be a regex, a string or a matcher function. Similar to added?.

with-message clj

Sets a human-readable message on the return value

work-dir clj

(work-dir job)

(work-dir job wd)

Gets or sets work dir for the job