FasterCI Configuration

FasterCI repository configuration file

Type Config
File match **/.fasterci/config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/fasterci-configuration/latest.json
Source https://fasterci.com/config.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: Config

Definitions

BazelStep object
build_targets string[]

List of bazel targets to build

test_targets string[]

List of bazel targets to test

build_flags string[]

Build flags to use in addition to defined in /etc/bazel.bazelrc

test_flags string[]

Test flags to use in addition to defined in /etc/bazel.bazelrc

BranchesAndPaths object
branches string[] required

List of branch name masks (doubleglob) to match

paths string[]

List of path masks (doubleglob) to match. If not specified, all paths are matched

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

paths-ignore string[]

List of path masks (doubleglob) to match. If not specified, all paths are ignored

from-branches string[]

List of source branches masks (doubleglob) to match. If not specified will match any source branch name

from-branches-ignore string[]

List of source branches masks (doubleglob) to ignore. If not specified, no source branch names are ignored

BranchesOrTags object
branches string[]

List of branch name masks (doubleglob) to match

tags string[]

List of tag masks (doubleglob) to match

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

tags-ignore string[]

List of tag masks (doubleglob) to ignore

Config object
workflows Workflow[] required

The list of FasterCI workflows

On object
push object
Any of: variant, variant
4 nested properties
branches string[]

List of branch name masks (doubleglob) to match

tags string[]

List of tag masks (doubleglob) to match

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

tags-ignore string[]

List of tag masks (doubleglob) to ignore

pull_request object
6 nested properties
branches string[] required

List of branch name masks (doubleglob) to match

paths string[]

List of path masks (doubleglob) to match. If not specified, all paths are matched

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

paths-ignore string[]

List of path masks (doubleglob) to match. If not specified, all paths are ignored

from-branches string[]

List of source branches masks (doubleglob) to match. If not specified will match any source branch name

from-branches-ignore string[]

List of source branches masks (doubleglob) to ignore. If not specified, no source branch names are ignored

Step object
name string

Step name, optional

working-directory string

Directory to run the step instead of default repo directory

github_check boolean

Report the result of the step as a separate github check

github_check_md_file string

After completing the step, report as a separate Github Check, using the content of the file as a report body, optional

run string

Arbitrary command execution; Could be multiline

bazel object
4 nested properties
build_targets string[]

List of bazel targets to build

test_targets string[]

List of bazel targets to test

build_flags string[]

Build flags to use in addition to defined in /etc/bazel.bazelrc

test_flags string[]

Test flags to use in addition to defined in /etc/bazel.bazelrc

side_effects boolean

Side effects step is anything that may change the state not related to building from the source tree or tests execution. Think of publishing artifacts, sending notifications etc.

Workflow object
name string required

Workflow name

on object required
Any of: variant, variant
2 nested properties
push object
Any of: variant, variant
4 nested properties
branches string[]

List of branch name masks (doubleglob) to match

tags string[]

List of tag masks (doubleglob) to match

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

tags-ignore string[]

List of tag masks (doubleglob) to ignore

pull_request object
6 nested properties
branches string[] required

List of branch name masks (doubleglob) to match

paths string[]

List of path masks (doubleglob) to match. If not specified, all paths are matched

branches-ignore string[]

List of branch name masks (doubleglob) to ignore

paths-ignore string[]

List of path masks (doubleglob) to match. If not specified, all paths are ignored

from-branches string[]

List of source branches masks (doubleglob) to match. If not specified will match any source branch name

from-branches-ignore string[]

List of source branches masks (doubleglob) to ignore. If not specified, no source branch names are ignored

image string

Docker image to run the workflow

cleanup string

optional cleanup command, executed after the workflow

max_parallel integer

optional maximum number of parallel runs of this workflow

ephemeral boolean

optionally mark this workflow as ephemeral. Will not keep the workflow state between runs

env object

Environment variables

secrets string[]

List of secrets to mount as environment variables

hide_from_github boolean

Do not notify github

init string

Optional command to run before the workflow. Use multiline for multiple commands

steps Step[]

List of workflow steps to execute