moon.yml
Moonrepo project configuration file
| Type | object |
|---|---|
| File match |
moon.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/moon-yml/latest.json |
| Source | https://raw.githubusercontent.com/moonrepo/moon/master/website/static/schemas/project.json |
Validate with Lintel
npx @lintel/lintel checkConfigures information and tasks for a project. Docs: https://moonrepo.dev/docs/config/project
Properties
Other projects that this project depends on.
A mapping of environment variables that will be set for all tasks within the project.
A mapping of group IDs to a list of file paths, globs, and environment variables, that can be referenced from tasks.
Overrides the ID within the project graph, as defined in the workspace projects setting.
The primary programming language of the project.
Defines ownership of source code within the current project, by mapping file paths and globs to owners. An owner is either a user, team, or group.
The default platform for all tasks within the project, if their platform is unknown.
Expanded information about the project.
A list of tags that this project belongs to, for categorizing, boundary enforcement, and task inheritance.
A mapping of tasks by ID to parameters required for running the task.
Overrides top-level toolchain settings, scoped to this project.
Overrides top-level workspace settings, scoped to this project.
Definitions
The scope and or relationship of the dependency.
The source where the dependency comes from. Either explicitly defined in configuration, or implicitly derived from source files.
A file group input.
Available formats to resolve the file group into.
A file path input.
Regex pattern to match the file's contents against when determining affected status.
The literal file path.
Mark the file as optional instead of logging a warning when hashing a task.
A file path output.
The literal file path.
Mark the file as optional instead of failing with an error after running a task and the output doesn't exist.
A glob pattern input.
Cache the glob walking result for increased performance.
The glob pattern.
A glob pattern output.
The glob pattern.
Mark the file as optional instead of failing with an error after running a task and the output doesn't exist.
Supported programming languages that each project can be written in.
The layer within the project stack, for categorizing.
Defines ownership of source code within the current project, by mapping file paths and globs to owners. An owner is either a user, team, or group.
Bitbucket only. A mapping of custom groups (prefixed with @@@), to a list of user and normal groups.
The default owner for paths.
GitLab only. Marks the code owners section as optional.
A mapping of file paths and file globs to owners. When a list, the defaultOwner is the owner, and each item is a path. When an object, the key is a path, and the value is a list of owners.
Bitbucket and GitLab only. The number of approvals required for the request to be satisfied. For Bitbucket, utilizes the Check() condition. For GitLab, marks the code owners section as required.
A mapping of file paths and file globs to owners.
Platforms that each programming language can belong to.
Strategies and protocols for locating plugins.
Expanded information about a project dependency.
Metadata about the source.
Expanded information about a project dependency.
Configures our Docker integration.
Configures aspects of the Docker scaffolding process.
List of glob patterns, relative from the project root, to include (or exclude) in the sources skeleton.
An external project input.
A file group identifier within the project in which to determine affected status.
A list of globs, relative from the project's root, in which to determine affected status.
A file group identifier within the project in which to determine affected status.
The external project identifier.
Expanded information about the project.
The Slack, Discord, etc, channel to discuss the project. Must start with a #.
A description on what the project does, and why it exists.
The individual maintainers of the project. The format is unspecified.
Custom metadata fields.
A human-readable name of the project.
The owner of the project. Can be an individual, team, or organization. The format is unspecified.
Overrides top-level toolchain settings.
Version of the tool this project will use.
Overrides top-level toolchain settings, scoped to this project.
Overrides bun settings.
The default toolchain(s) for all tasks within the project, if their toolchain is unknown.
The default toolchain(s) for all tasks within the project, if their toolchain is unknown.
Overrides deno settings.
Overrides node settings.
Overrides toolchains by their ID.
Overrides python settings.
Overrides rust settings.
Overrides top-level workspace settings, scoped to this project.
Controls how tasks are inherited.
The technology stack of the project, for categorizing.
Configures a command to execute, and its arguments.
Configures a task to be ran within the action pipeline.
Arguments to pass to the command when it's ran. Can be defined as a string, or a list of individual arguments.
The command or command line to execute when the task is ran. Supports the command name, with or without arguments. Can be defined as a string, or a list of individual arguments.
Other tasks that this task depends on, and must run to completion before this task is ran. Can depend on sibling tasks, or tasks in other projects, using targets.
A human-readable description about the task.
A mapping of environment variables that will be set when the task is ran.
Extends settings from a sibling task by ID.
Inputs and sources that will mark the task as affected when comparing against touched files. When not provided, all files within the project are considered an input. When an empty list, no files are considered. Otherwise, an explicit list of inputs are considered.
Marks the task as local only. Local tasks do not run in CI, do not have options.cache enabled, and are marked as options.persistent.
Outputs that will be created when the task has successfully ran. When cache is enabled, the outputs will be persisted for subsequent runs.
The platform in which the task will be ran in. The platform determines available binaries, lookup paths, and more. When not provided, will be automatically detected.
The preset to apply for the task. Will inherit default options.
A script to run within a shell. A script is anything from a single command, to multiple commands (&&, etc), or shell specific syntax. Does not support arguments, merging, or inheritance.
List of additional toolchain(s) in which the task will be ran in. The toolchain determines available binaries, lookup paths, and more. This list will be merged with detected toolchains.
List of additional toolchain(s) in which the task will be ran in. The toolchain determines available binaries, lookup paths, and more. This list will be merged with detected toolchains.
The type of task, primarily used for categorical reasons. When not provided, will be automatically determined.
Configures another task that a task depends on.
Expanded information about a task dependency.
Additional arguments to pass to this dependency when it's ran.
A mapping of environment variables specific to this dependency.
Marks the dependency is optional when being inherited from the top-level.
The target of the depended on task.
The strategy in which to merge a specific task option.
The operating system in which to only run this task on.
Options to control task inheritance and execution.
The pattern in which affected files will be passed to the task.
When affected and no files are matching, pass the task inputs as arguments to the command, instead of ..
Allows the task to fail without failing the entire pipeline.
Caches the outputs of the task. Defaults to true if outputs are configured for the task.
A custom key to include in the cache hashing process. Can be used to invalidate local and remote caches.
Lifetime to cache the task itself, in the format of "1h", "30m", etc. If not defined, caches live forever, or until inputs change.
Loads and sets environment variables from the .env file when running the task.
Automatically infer inputs from file groups or environment variables that were utilized within command, script, args, and env.
Marks the task as interactive, so that it will run in isolation, and have direct access to stdin.
Marks the task as internal, which disables it from begin ran from the command line, but can be depended on.
The default strategy to use when merging args, deps, env, inputs, or outputs with an inherited task. Can be overridden with the other field-specific merge options.
The strategy to use when merging args with an inherited task.
The strategy to use when merging deps with an inherited task.
The strategy to use when merging env with an inherited task.
The strategy to use when merging inputs with an inherited task.
The strategy to use when merging outputs with an inherited task.
Creates an exclusive lock on a virtual resource, preventing other tasks using the same resource from running concurrently.
The operating system in which to only run this task on.
The style in which task output will be printed to the console.
Marks the task as persistent (continuously running). This is ideal for watchers, servers, or never-ending processes.
Marks the task with a certain priority, which determines the order in which it is ran within the pipeline.
The number of times a failing task will be retried to succeed.
Runs direct task dependencies (via deps) in sequential order. This does not apply to indirect or transient dependencies.
Runs the task from the workspace root, instead of the project root.
Whether to run the task in CI or not, when executing moon ci or moon run.
Runs the task within a shell. When not defined, runs the task directly while relying on PATH resolution.
The maximum time in seconds that a task can run before being cancelled.
The shell to run the task in when on a Unix-based machine.
The shell to run the task in when on a Windows machine.
The style in which task output will be printed to the console.
Preset options to inherit.
The priority levels a task can be bucketed into.
The type of task.
A list of available shells on Unix.
A list of available shells on Windows.
Configures an individual toolchain.
Arbitrary configuration that'll be passed to the WASM plugin.
Location of the WASM plugin to use.
The version of the toolchain to download and install.
Inherit the version from the root .prototools. When true, matches using the same ID, otherwise a string can be provided for a custom ID.
Strategy in which to inherit a version from .prototools.
Represents an unresolved version or alias that must be resolved to a fully-qualified version.