Api functions, which can be invoked by build scripts. These often delegate to more specific namespaces, but this namespace is provided as a convenient entry point.
The general intention is to provide functions for most purposes, without the user having to resort to using keywords and maps.
Api functions, which can be invoked by build scripts. These often delegate to more specific namespaces, but this namespace is provided as a convenient entry point. The general intention is to provide functions for most purposes, without the user having to resort to using keywords and maps.
Declares an action job with id, action and options
Declares an action job with id, action and options
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.
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.
True if the build has been triggered via api (i.e. typically manually by a human)
True if the build has been triggered via api (i.e. typically manually by a human)
Retrieves list of available container architectures from context
Retrieves list of available container architectures from context
(artifact id path)Defines a new artifact with given id, located at given path. This can be passed
to save-artifacts or restore-artifacts.
Defines a new artifact with given id, located at given `path`. This can be passed to `save-artifacts` or `restore-artifacts`.
(bash id & cmds)Creates an action job that executes given commands in a bash shell
Creates an action job that executes given commands in a bash shell
(blocked job)Gets or sets job blocked status. A blocked job will be marked as blocked once it
is eligible for execution. An explicit unblock action is required to execute it.
Gets or sets job blocked status. A blocked job will be marked as `blocked` once it is eligible for execution. An explicit unblock action is required to execute it.
Checks if given job is marked as blocked
Checks if given job is marked as blocked
Retrieves parameters this build has access to
Retrieves parameters this build has access to
Defines a cache with given id an path, that can be passed to caches
Defines a cache with given id an path, that can be passed to `caches`
Returns the build checkout directory
Returns the build checkout directory
True if the build has been triggered from the cli
True if the build has been triggered from the cli
(container-job id & [opts])Declares an container job with id and container options
Declares an container job with id and container options
Checks if argument is an container job
Checks if argument is an container job
Gets the configured dependencies of a job
Gets the configured dependencies of a job
(depends-on job & deps)Adds dependencies to the given job. Does not overwrite existing dependencies.
Adds dependencies to the given job. Does not overwrite existing dependencies.
(dir-artifact art)Converts artifact that points to a file, to one that points to its parent directory. If there is no parent directory, uses the current directory.
Converts artifact that points to a file, to one that points to its parent directory. If there is no parent directory, uses the current directory.
(env job)(env job e)Gets or sets environment vars for the job
Gets or sets environment vars for the job
(expose job)(expose job ports)Gets or sets exposed ports
Gets or sets exposed ports
List of files that have been added for this build
List of files that have been added for this build
List of modified files for this build
List of modified files for this build
List of removed files for this build
List of removed files for this build
(get-artifact ctx {:keys [path] :as art})Retrieves artifact with given id and restores it at the location indicated
by the archive path.
Returns the restored artifact path, or nil if the artifact was not found.
Retrieves artifact with given id and restores it at the location indicated by the archive `path`. Returns the restored artifact path, or `nil` if the artifact was not found.
(get-job ctx id)Retrieves job by id in the current build
Retrieves job by id in the current build
(get-job-exposed-addr ctx id port)If the given job exposes a port, looks it up in the context and returns the
externally accessible address as a map with :port and :address keys. If
the job is not found, or the given port is not mapped, returns nil.
If the given job exposes a port, looks it up in the context and returns the externally accessible address as a map with `:port` and `:address` keys. If the job is not found, or the given port is not mapped, returns `nil`.
(image job)(image job img)Gets or sets container image
Gets or sets container image
(in-work ctx p)Given a relative path p, returns it as a subpath to the job working directory.
Fails if an absolute path is given.
Given a relative path `p`, returns it as a subpath to the job working directory. Fails if an absolute path is given.
(init job)(init job init)Gets or sets container job initializer
Gets or sets container job initializer
Retrieves the result of the job, if it has finished
Retrieves the result of the job, if it has finished
(job-work-dir ctx)Gets the work dir for the current job in the context as an absolute path
Gets the work dir for the current job in the context as an absolute path
Gets configured main branch from the build.
Gets configured main branch from the build.
Checks if the build branch is the configured main branch.
Checks if the build branch is the configured main branch.
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?.
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?`.
(param-to-file ctx param out)Takes the value of param from the build parameters and writes it to
the file at path out. Creates any directories as needed. Returns
nil if the operation succeeded.
Takes the value of `param` from the build parameters and writes it to the file at path `out`. Creates any directories as needed. Returns `nil` if the operation succeeded.
Applies the given regex on the ref from the context, returns the matching groups.
Applies the given regex on the ref from the context, returns the matching groups.
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?.
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?`.
Configures the artifacts to restore on a job.
Configures the artifacts to restore on a job.
Configures the artifacts to save on a job.
Configures the artifacts to save on a job.
(script job)(script job script)Gets or sets container job script
Gets or sets container job script
(size job)(size job s)Gets or sets the resource size of the container job. Size 1 means 1 cpu, 2 GB, size 2 doubles that, etc...
Gets or sets the resource size of the container job. Size 1 means 1 cpu, 2 GB, size 2 doubles that, etc...
Indicates the job was intentionally skipped
Indicates the job was intentionally skipped
Returns the trigger source (e.g. api)
Returns the trigger source (e.g. `api`)
Job result that indicates the job was successful
Job result that indicates the job was successful
Gets commit tag (if any) from the context.
Gets commit tag (if any) from the context.
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?.
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?`.
(unblocked job)Unmarks a previously blocked job as unblocked. Note that this has no effect if the
job lifecycle status is already blocked, it only affects the job blocked status
before the script is started.
Unmarks a previously blocked job as unblocked. Note that this has no effect if the job lifecycle status is already blocked, it only affects the job `blocked` status before the script is started.
Sets a human-readable message on the return value
Sets a human-readable message on the return value
(work-dir job)(work-dir job wd)Gets or sets work dir for the job
Gets or sets work dir for the job
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |