key: key

description: Block property key and value pair.


key: dimension

description: The dimension the entity is currently in.

type: string


key: feature

description: Name of a structure.


key: fluid

description: The fluid at the location.

type: object

type: boolean integer string object


description: The fluid ID.


key: tag

description: The fluid tag.


key: state

description: A map of fluid property names to values. Test will fail if the fluid doesn't match.


key: light

description: The light at the location.

type: integer object


description: The light Level of visible light. Calculated using: (max(sky-darkening,block)).


key: x

description: The X position.


key: y

description: The Y position.


key: z

description: The Z position.


key: smokey

description: True if the block is closely above a campfire or soul campfire.

type: boolean


key: effects

description: A map of status effects.


key: additionalProperties

description: A status effect with the key name being the status effect name.


key: ambient

description: Whether the effect is from a beacon.


key: amplifier

description: The effect amplifier.


key: duration

description: The effect duration in ticks.


key: visible

description: Whether the effect has visible particles.


key: flags

description: Predicate Flags to be checked.


Test whether the entity is or is not on fire.


description: Test whether the entity is or is not sneaking.


description: Test whether the entity is or is not sprinting.


description: Test whether the entity is or is not swimming.


description: Test whether the entity is or is not a baby variant.


description: Lightning bolt properties to be checked. Fails when entity is not a lightning bolt.

type: integer


description: Number of blocks set on fire by this lightning bolt.


Entity properties of entities struck by this lightning bolt. If present, this tag must match one or more entities.


key: nbt

description: An NBT string.


key: passenger

description: The entity directly riding this entity.


key: player

description: Player properties to be checked. Fails when entity is not a player.

type: boolean object

enum: survival adventure creative spectator

enum: minecraft:custom minecraft:crafted minecraft:used minecraft:broken minecraft:mined minecraft:killed minecraft:picked_up minecraft:dropped minecraft:killed_by


The entity that the player is looking at, as long as it is visible and within a radius of 100 blocks.


key: advancements

description: A map of advancements to check.


description: An advancement ID.


key: gamemode

description: The game mode of the player.


key: level

description: The level of the player.


key: recipes

description: A map of recipies to check.


key: stats

description: List of statistics to match.


key: type

description: The statistic base.


key: stat

description: The statistic ID. Mostly mimics the criteria used for defining scoreboard objectives.


key: value

description: The value of the statistic.


Location predicate for the block the entity is standing on.


key: team

description: The team the entity belongs to.


description: An entity ID.


The entity which this entity is targeting for attacks.


key: vehicle

description: The vehicle that the entity is riding on.


key: conditions

description: The condition's ID.


key: target

description: Restrict this dependency to matching only a Project or a Package

enum: project package


key: script

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

type: string array


key: packInclude

description: Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }


key: publishExclude

description: Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compile

description: Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compileExclude

description: Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compileFiles

description: Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: content

description: Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: contentExclude

description: Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: contentFiles

description: Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: preprocess

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: preprocessExclude

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: preprocessFiles

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: resource

description: Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: resourceExclude

description: Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: resourceFiles

description: Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: shared

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: sharedExclude

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: sharedFiles

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: exclude

description: Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: excludeBuiltIn

description: Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

default: bin/** obj/** **/*.xproj


key: configurations

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.


key: copyright

description: Copyright details for the package.


key: iconUrl

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.


key: licenseUrl

description: A link to the license for the package.


key: requireLicenseAcceptance

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.


key: projectUrl

description: A URL for the home page of the package.


key: summary

description: A short description of the package.


key: tags

description: A space-delimited list of tags and keywords that describe the package.

type: array


key: title

description: The human-friendly title of the package


key: releaseNotes

description: A description of the changes made in each release of the package.


key: language

description: The locale ID for the package, such as en-us.


key: description

description: The description of the project/package.


key: namedResource

description: Overrides the generated resource names with custom ones.


key: repository

description: Contains information about the repository where the project is stored.

default: git


key: scripts

description: Scripts to execute during the various stages.


key: version

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*


key: webroot

description: Specifies the web server root for the application. In Visual Studio when running IIS this folder will be used as the root of the application. Static files should be put in here.


key: parser

description: A special syntax parser (for example, SCSS).


key: stringifier

description: A special syntax output generator (for example, Midas).


key: syntax

description: An object providing a syntax parser and a stringifier.


key: map

description: Source map options.


key: from

description: The input file name (most runners set it automatically).


key: to

description: The output file name (most runners set it automatically).


key: plugins

description: An array of plugins.


description: An object of options.


key: full

description: Json schema version for the vEnvironment-Basic configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.


description: Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.


description: Global settings for all scenarios.

default: internal-realtime

enum: internal-realtime external-software

examples: internal-realtime external-software

time-source: internal-realtime


key: time-source

description:
Time source for the simulation. Operate without hardware and simulate all buses completely.
'internal-realtime': The time response of the measurement (time basis) is controlled internally.
'external-software': The time response of the measurement (time basis) is controlled by an external program.


description: A lists of system variables to be used by the simulation.


description: The definition of datasources used by application models.


description: List of user files.


description: List of functional mockup units.


description: SIL Kit settings.


key: registry-uri

description: The URI of the registry.


key: participant-name

description: Name used by the simulation tool to join a simulation as a participant at the start of a measurement.


key: simulation-step-in-micro-sec

description: Time length of a single simulation step. Valid only for the time-source "external-software".


key: life-cycle-event-timeout-in-sec

description: Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software".


description: Configuration of the logging for the environment.

default: application-layer bus diagnostic internal statistic system-variable test


description: Global settings for all scenarios.


description: SIL Kit settings.


description: registry URI


description: Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.


description: Configuration of the standalone logging block.

default: bus diagnostic internal statistic system-variable test


description: Absolute or relative path to an external file containing system variables. Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to user files that can be read/written by CAPL/.NET Scripts. Relative path specifications are resolved relative to the defining configuration file.


key: stepsize-in-sec

description: Step size in seconds.

type: number


key: debug-output

description: Is the debug output active.


key: active-model-variables

description: List of the FMU variables which should be exported


key: inactive-model-variables

description: List of the FMU variables which should be excluded from the export


description: Represents a functional mockup unit used in a scenario.

required: file-path stepsize-in-sec


description: Absolute or relative path to a SIL Kit config file (.yaml or .json). Relative path specifications are resolved relative to the configuration file.


description: Name of a blf file, supporting the field codes: {ComputerName}, {LocalTime}, {MeasurementIndex}, {MeasurementStart}, {IncSize|001|100MB} and {IncTime|001|01h00m}.


description: Advanced logging configurations.


description: step size in seconds


description: Are the debug outputs on


description: Represents a functional mockup unit used in a scenario


description: Advanced logging configurations


description: Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.


description: Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.


key: sourcePrefixes

description: The prefixes of your source imports. Ex: import sth from '@data' => '@' can considered as a sourcePrefix


key: sectionPrefix

description: The prefix of your section title


key: sectionNames

description: The names (which comes right after 'sectionPrefix') of your section title


key: startImportBlockSign

description: The sign to mark the start of import block. Default is '' - the start of the file


key: endImportBlockSign

description: The sign to mark the end of import block. Default is '' - the first empty line


key: statementTerminator

description: The sign to mark the end of an import statement. Default is ';'


key: preCommands

description: The command list run before sorting

default: terminal


key: items

description: string value means terminal command


description: Define command with vscode command option


key: command

description: the command you need to execute before sorting. It can be terminal command or vscode command


key: system

description: Define the system will execute the command


description: Command will be executed as vscode command


description: Command will be executed as terminal command


key: options

description: Set the options for grunt-contrib-copy


key: force

description: This overrides this task from blocking deletion of folders outside current working dir (CWD). Use with caution.


key: no-write

description: Will log messages of what would happen if the task was ran but doesn't actually delete the files.


key: cvars

description: CVar name


key: commands

description: Console command name


key: value

description: The default value of the CVar


description: This indicates where the assets are stored

default: Assets


description: This indicates where the code is stored

default: Code


key: name

description: This indicates the project name


key: engine

description: This indicates which engine version will be used


key: path

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby


key: type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one


description: Arguments that has to be passed to the command. Leave empty if it has not parameters


description: Name of the Docker image which may or may not include registry URL, tag, and digest value


description: Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory


key: username

description: Username to use to fetch the Docker image


key: password

description: Password to use to fetch the Docker image


key: email

description: Email to use to fetch the Docker image


key: access-key

description: AWS access key for Amazon Elastic Container Registry (AWS ECR)


key: secret-key

description: AWS secret key for Amazon Elastic Container Registry (AWS ECR)


key: oidc-role

description: Provides Pipeline with access to private Docker images hosted in an Amazon Elastic Container Registry (AWS ECR)


description: Maximum amount of minutes a step can execute


key: size

description: Multiplier of the resources allocated to a pipeline step


description: Contains settings to clone the repository into a container

const: full


key: enabled

description: Enables cloning of the repository before a step in a pipeline


key: lfs

description: Enables the download of LFS files in the clone (supported only for Git repositories)


key: depth

description: Depth of Git clone (supported only for Git repositories)


key: skip-ssl-verify

description: Disables SSL verification during git clone, allowing the use of self-signed certificates


description: Files produced by a step to share with a following step


key: items

description: Glob pattern for the path to the artifacts


key: download

description: Enables downloading of all available artifacts at the start of a step


description: Any label assigned to a self-hosted repository or workspace Pipeline runner


key: changesets

description: Condition on the changesets involved in a pipeline


key: includePaths

description: Condition which holds only if any of the modified files match any of the defined patterns


description: Glob pattern to match the file path


key: step

description: Build execution unit


key: after-script

description: Commands to execute after the step succeeds or fails


key: caches

description: Caches enabled for the step


description: Name of the cache


key: condition

description: Condition to execute the step


key: deployment

description: Type of environment for the deployment step, used in the Deployments dashboard


key: fail-fast

description: A flag reflecting whether other steps in a parallel group should be force stopped if this step fails


key: name

description: Name of the step


key: oidc

description: Enable the use of OpenID Connect to connect a pipeline step to a resource server


key: runs-on

description: List of labels assigned to Pipeline runner


key: script

description: Commands to execute in the step


key: services

description: Services enabled for the step


description: Name of the service


key: trigger

description: Specifies if a step runs automatically or only when manually triggered by a user


description: Condition to execute the stage


description: Type of environment for the deployment stage, used in the Deployments dashboard


description: Name of the stage


key: steps

description: List of steps in a stage


description: Specifies if the stage runs automatically or only when manually triggered by a user


description: Set of steps to run concurrently


description: A flag reflecting whether all steps in a parallel group should be force stopped if any of its steps fails.


key: items

description: Command to execute


key: pipe

description: Pipe to execute


description: Pipe identifier


key: variables

description: Environment variables passed to the pipe


description: Variable value


description: Array variable item value


description: Path to the directory to be cached, can be absolute or relative to the clone directory


description: Cache definition declaring a set of files as a key and path to the directory to be cached

required: key path


key: key

description: Cache key definition


description: Path to a file or glob pattern of files in the repository which form the cache key


key: definitions

description: Defines resources used elsewhere in the pipeline configuration


description: Defines custom caches to be used by pipelines


description: Defines services that run in separate Docker containers


key: memory

description: Memory limit for the service container, in megabytes


description: Environment variables passed to the service container


key: docker

description: A flag to add Docker to all build steps in all pipelines


key: branches

description: Branch-specific build pipelines


key: custom

description: Pipelines that can only be triggered manually or scheduled from the Bitbucket Cloud interface


description: List of variables for the custom pipeline


description: Name of a variable for the custom pipeline


key: default

description: Default value for the variable, used unless the value is manually set when the pipeline is run


key: allowed-values

description: A list of values that are allowed for the variable


description: Allowed value for the variable


key: description

description: Description of the variable


key: pull-requests

description: Pull-request-specific build pipelines


key: tags

description: Tag-specific build pipelines


description: Configuration file for Better Code Hub to override the default configuration.

enum: csharp cpp go groovy java javascript objectivec perl php python ruby scala script solidity swift typescript kotlin


description: A regular expression for the path(s) to exclude.


description: A regular expression for the path(s) to include.


description: Config file for Netlify CMS

enum: yml yaml toml json frontmatter yaml-frontmatter toml-frontmatter json-frontmatter

default: en

enum: unicode ascii

default: unicode

required: backend media_folder collections


key: label

description: label for the collection in the editor UI; defaults to the value of name


singular label for certain elements in the editor; defaults to the value of label


key: folder

description:
Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository.
Note: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection "must have a field that is a valid entry identifier".


key: path

description: Path


key: format

description: determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.


key: slug

description:
For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).

Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}}
{{slug}}: a url-safe version of the title field (or identifier field) for the file
{{year}}: 4-digit year of the file creation date
{{month}}: 2-digit month of the file creation date
{{day}}: 2-digit day of the month of the file creation date
{{hour}}: 2-digit hour of the file creation date
{{minute}}: 2-digit minute of the file creation date
{{second}}: 2-digit second of the file creation date


key: create

description: for folder collections only; allows users to create new items in the collection


key: hide

description: hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.


key: delete

description: prevents users from deleting items in a collection; defaults to true


key: name

description: unique identifier for the collection, used as the key when referenced in other contexts


key: filter

description: optional filter for folder collections


description: optional text, displayed below the label when viewing a collection


key: extension

description: the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items


key: fields

description: The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.


description: unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)


description: label for the field in the editor UI; defaults to the value of name


key: default

description: specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type.


key: required

description: makes a field required; defaults to true


key: pattern

description: add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)


description: Defaults to True


key: hint

description: optionally add helper text directly below a widget.


description: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets


description: unique identifier for the file


description: file label


key: file

description: unique filepath (relative to the base of the repo).


key: backend

description: specifies how to access the content for your site, including authentication


description: Set this property to connect Netlify to a local Git repo instead of a live one


description: specifies the folder path where uploaded files should be saved, relative to the base of the repo.


description: specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included.


description: Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.


description: should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content.


description:
When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).
Defaults to site_url.


description: Logo at the top of the login page. Assumed to be a URL to an image file


description: shows Deploy Preview Links


description:
For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).

The slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.

Available template tags:

Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}}
{{slug}}: a url-safe version of the title field (or identifier field) for the file
{{year}}: 4-digit year of the file creation date
{{month}}: 2-digit month of the file creation date
{{day}}: 2-digit day of the month of the file creation date
{{hour}}: 2-digit hour of the file creation date
{{minute}}: 2-digit minute of the file creation date
{{second}}: 2-digit second of the file creation date


key: encoding

description:
unicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.
ascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).


description: Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding.


description: The replacement string used to substitute unsafe characters; defaults to -


key: collections

description: The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.


key: editor

description: This setting changes options for the editor view of the collection. It has one option so far: preview


key: preview

description: Enable preview pane for this collection; defaults to true


key: summary

description:
This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field
Template tags are the same as those for slug, with the following additions:

{{filename}} The file name without the extension part.
{{extension}} The file extension.
{{commit_date}} The file commit date on supported backends (git based backends).
{{commit_author}} The file author date on supported backends (git based backends).


key: sortableFields

description:
An optional list of sort fields to show in the UI.
Defaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.
When author field can't be inferred commit author will be used.


description:
An optional list of predefined view filters to show in the UI.
Defaults to an empty list.


description: Schema for serverless framework configuration files

format: uri

enum: HEADER AUTHORIZER

type: string number

enum:
ANY /
GET /
POST /
PUT /
PATCH /
OPTIONS /
HEAD /
DELETE /
ANY /{proxy+}
GET /{proxy+}
POST /{proxy+}
PUT /{proxy+}
PATCH /{proxy+}
OPTIONS /{proxy+}
HEAD /{proxy+}
DELETE /{proxy+}


key: binaryMediaTypes

description: Optional binary media types the API might return


key: disableDefaultEndpoint

description: Disable the default 'execute-api' HTTP endpoint (default: false)


key: enabled

description: Can be used to disable the API key without removing it (default: true)


key: shouldStartNameWithService

description: Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.


key: layers

description: Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers


key: command

description: Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently


key: entryPoint

description: Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work


key: AwsDeploymentBucket

description: Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda


key: blockPublicAccess

description: Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.


key: maxPreviousDeploymentArtifacts

description: On deployment, serverless prunes artifacts older than this limit (default: 5)


key: name

description: Name of an existing bucket to use (default: created by serverless)


key: skipPolicySetup

description: Skip the creation of a default bucket policy when the deployment bucket is created (default: false)


key: versioning

description: Enable bucket versioning (default: false)


key: AwsEventBridge

description: Aws Lambda function Eventbridge event source


key: AwsHttpAuthorizer

description: AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers


key: arn

description: The arn of the cognito user pool


key: identitySource

description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name


description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`


description: Use an existing Api Gateway Authorizer created outside or in the same stack

required: type authorizerId


key: authorizerId

description: The Id of the existing authorizer


key: AwsProvider

description: Configuration for Serverless AWS

enum: EDGE PRIVATE REGIONAL

enum: direct changesets


key: scanOnPush

description: Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)


key: uri

description: URI of an existing Docker image in ECR


key: path

description: Path to the Docker context that will be used when building that image locally (default: '.')


key: file

description: Dockerfile that will be used when building the image locally (default: 'Dockerfile')


key: apiName

description: Change this to use a custom name for the API Gateway API


key: memorySize

description: Note: API Gateway has a maximum timeout of 30 seconds


key: versionFunctions

description: Use function versioning (enabled by default)


key: deploymentMethod

description: Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method


key: disableRollback

description: Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.


key: ServerlessFrameworkResources

description: Serverless Framework Additional Resources Configuration


description: This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition


key: ServerlessServiceConfiguration

description: **@deprecated and doesn't work in serverless framework v3**


key: format

description: Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html


key: accessLogging

description: Enables HTTP access logs (default: true)


key: executionLogging

description: Enable execution logging (default: true)


key: fullExecutionData

description: Log full requests/responses for execution logging (default: true)


key: localPath

description: The path to the local .js file that contains the plugin


description: Describes a format for specifying how to replay single compilations independently of the build system

required: directory file command

required: directory file arguments


key: directory

description: The working directory of the compilation. All paths specified in the command or file fields must be either absolute or relative to this directory.


description: The main translation unit source processed by this compilation step. This is used by tools as the key into the compilation database. There can be multiple command objects for the same file, for example if the same source file is compiled with different configurations.


key: command

description: The compile command executed. After JSON unescaping, this must be a valid command to rerun the exact compilation step for the translation unit in the environment the build system uses. Parameters use shell quoting and shell escaping of quotes, with '"' and '\' being the only special characters. Shell expansion is not supported.


key: arguments

description: The compile command executed as list of strings.


key: output

description: The name of the output created by this compilation step. This field is optional. It can be used to distinguish different processing modes of the same input file.


key: main

description: The entry point to the definition (canonical to `"main"` in NPM's `package.json`).


key: browser

description: A string, or map of paths, to override during resolution. See spec: https://github.com/defunctzombie/package-browser-field-spec

type: object string


key: version

description: The semver range this definition is typed for


key: homepage

description: Homepage url of the source package


key: resolution

description: Map of resolutions to install


key: files

description: Used as an alternative or to complement `main`, specify an array of files that are exported but aren't already part of the resolution from `main`.


key: global

description: Denote that this definition _must_ be installed as global.


key: postmessage

description: A message to emit to users after typings installation.


key: name

description: The name of the definition


key: dependencies

description: A map of dependencies required by the project.


key: devDependencies

description: A map of dependencies required by the project during development.


key: peerDependencies

description: A map of dependencies expected in the parent project for this dependency to work.


key: globalDependencies

description: A map of global dependencies required by the project.


key: globalDevDependencies

description: A map of global dependencies required by the project during development.


description:
Schema of the build flow configuration file `zinoma.yml`.

In order to use Žinoma with your project, you need to create a file named `zinoma.yml`. We recommend putting this file in the root directory of your project.

This struct describes the schema expected for this file. It assumes prior knowledge of the Yaml format.

__Example__

`zinoma.yml`:

```yaml targets: download_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install

test: input: - download_dependencies.output - paths: [package.json, src, test] build: npm test

lint: input: - download_dependencies.output - paths: [package.json, src, test] build: npm run lint

check: dependencies: [test, lint]

start: input: - download_dependencies.output - paths: [package.json, src] service: exec npm run start

build: dependencies: [check] input: - paths: - Dockerfile - package.json - package-lock.json - src output: - paths: [lambda.zip] build: | docker build -t build-my-project:latest . docker create -ti --name build-my-project build-my-project:latest bash docker cp build-my-project:/var/task/lambda.zip ./ docker rm -f build-my-project ```

In this example:

- `zinoma check` will ensure the code complies to the test suites and the coding standards. - `zinoma start --watch` will run the application and restart it whenever the sources are updated. - `zinoma --clean build` will generate a clean artifact, ready to be deployed.

A fully functional and more advanced example project is available in [fbecart/zinoma-node-example](https://github.com/fbecart/zinoma-node-example).


key: imports

description:
Import definitions from other Žinoma projects.

`imports` should be an object, the keys being the project names and the values their respective paths.

Before importing a project, you should make sure this project has its name defined. You should use the same name as key in the `imports` object.

Once a project is imported, targets from that project can be referenced by specifying their fully qualified name: `imported_project_name::target_name`.

__Example__

`packages/api/zinoma.yml`:

```yaml name: api

targets: test: build: cargo test ```

`packages/webapp/zinoma.yml`:

```yaml name: webapp

targets: test: build: cargo test ```

`./zinoma.yml`:

```yaml imports: api: packages/api webapp: packages/webapp

targets: test_all: dependencies: [api::test, webapp::test] ```

In this example, the target `test_all` depend from targets defined in different projects.


description:
Name of the project.

A project name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.

Project names should be unique. Two projects cannot have the same name.

__Example__

```yaml name: my_project ```


key: targets

description:
Targets (aka tasks) of this project.

[`Targets`] represent commands and scripts to execute in your build flow.

[`Targets`]: struct.Target.html

Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.

[`dependencies`]: enum.Target.html#variant.Build.field.dependencies

Each target must have a unique name inside the project. The target name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.

__Example__

```yaml targets: speak_cow: build: echo 'Moo' speak_dog: build: echo 'Woof!' ```

In this example:

- `zinoma speak_cow` will print `Moo` - `zinoma speak_dog` will print `Woof!` - `zinoma speak_cow speak_dog` will print both `Moo` and `Woof!` (not necessarily in this order)


key: Dependencies

description:
List of [`targets`] that must complete successfully before this target can be built.

[`targets`]: enum.Target.html

It should be an array of strings.

If any of the dependencies fails to complete, this target will not be executed.

__Example__

```yaml targets: target1: dependencies: [] target2: dependencies: [target1] target3: dependencies: [target2] ```

In this example, `target1` must complete successfully before `target2` begins, while `target3` waits for `target2` to complete.

`zinoma target2` will run sequentially `target1` and `target2`.

`zinoma target3` will run sequentially `target1`, `target2` and `target3`.


key: InputResource

description:
Output resources of another target.

It should be a string with the format `<project_name>::<target_name>.output`. If the other target is located in the same project, the project name can be skipped. The `input` would then have this format: `<target_name>.output`.

When such an input is used:

- all the output resources of the other target become input resources for this target; - the other target implicitly becomes a dependency to this target.

__Example__

```yaml targets: node_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install

compile: input: - node_dependencies.output - paths: [package.json, tsconfig.json, src] output: - paths: [dist] build: tsc

run: input: - node_dependencies.output - paths: [package.json] - compile.output service: node dist/index.js ```


key: extensions

description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: fmt: input: - paths: [src, tests] extensions: [rs] build: exec cargo fmt --all -- --check


key: paths

description:
Paths to files or directories.

It should be an array of strings.

Each element of the array should be a path to a file or directory.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```


description:
Shell script whose output identifies the state of a resource.

It should be a string.

__Example__

```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format "{{.ID}}"' output: - cmd_stdout: 'docker image ls webapp:latest --format "{{.ID}}"' build: docker build -t webapp . ```


key: InputResources

description:
List of artifacts that this target depends on.

`input` should be an array of [`resources`].

[`resources`]: enum.InputResource.html

Specifying a target's `input` enables the incremental build for this target. This means that, at the time of executing the target, Žinoma will skip its build if its input resources (and [`output`] resources, if any) have not changed since its last successful completion.

[`output`]: struct.OutputResources.html

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] build: npm install ```

In this example, running `zinoma npm_install` once will execute `npm install`. Subsequent runs of `zinoma npm_install` will return immediately — until the content of `package.json` or `package-lock.json` is modified.


description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: protoc: input: - paths: [protos] extensions: [proto] output: - paths: [protos] extensions: [go] build: | cd protos docker run -v `pwd`:/defs namely/protoc-all -d . -o . -l go


description:
Paths to files or directories.

It should be an array of strings. Each element of the array should be a path to a file or directory.

If the `--clean` flag is provided to `zinoma`, the files or directories specified in `paths` will be deleted before running the build flow.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

In this example, as the target specifies an `input`, `zinoma npm_install` is incremental. The script `npm install` will be skipped until `package.json`, `package-lock.json` or `node_modules` are modified.

Additionally:

- the command `zinoma --clean` will delete `node_modules`; - the command `zinoma --clean npm_install` will delete `node_modules`, then run `npm install`.


key: OutputResources

description:
List of artifacts produced by this target.

It should be an array of [`resources`].

[`resources`]: enum.OutputResource.html

The incremental build takes in account the target `output`. Just like with [`input`], if any of the target output resources were altered since its previous successful execution, the target state will be invalidated and its build will be run again.

[`input`]: struct.InputResources.html

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

In this example, running `zinoma npm_install` will return immediately in case `package.json`, `package-lock.json` and `node_modules` were not modified since the last completion of the target.

Running `zinoma --clean npm_install` will start by deleting `node_modules`, then will run `npm install`.


key: Target

description:
A target is a command or a set of commands to run as part of your build flow.

Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.

[`dependencies`]: struct.Dependencies.html


description:
A build target represents a shell script to run as part of your build flow.

This build script is expected to eventually complete, as opposed to the run script of a [`service`] target.

[`service`]: #variant.Service.field.service


key: build

description:
The shell script to run in order to build this target.

It should be a string. This string can be multi-line, in case of scripts with multiple commands.

__Example__

```yaml targets: create_file_deep: build: | mkdir -p deep/dir touch deep/dir/file output: - paths: [deep/dir/file] ```

In this example, running `zinoma create_file_deep` will execute the commands `mkdir -p deep/dir` and `touch deep/dir/my_file` sequentially.


description: Dependencies of the target.


key: input

description: Input resources of the target.


key: output

description: Output resources of the target.


description:
Service targets are useful to run scripts that do not complete.

They enable the execution of long-lasting commands, such as servers.


key: service

description:
Shell script starting a long-lasting service.

It should be a string.

If `zinoma` has no service target to run, it will automatically exit after all build targets ran to completion. On the contrary, if at least one service target is specified in the command line, `zinoma` will keep running even after all build targets completed, so that the services can remain alive.

In watch mode (when the `--watch` flag is passed to `zinoma`), services are restarted when the relevant paths are modified.

__Example__

```yaml targets: npm_server: input: - paths: [package.json, index.js] service: npm start ```

In this example, `zinoma npm_server --watch` will run `npm start`, and will restart this process every time `package.json` or `index.js` are updated.


description:
Aggregates other targets.

__Example__

```yaml targets: fmt: build: cargo fmt -- --check lint: build: cargo clippy test: build: cargo test check: dependencies: [fmt, lint, test] ```

In this example, the target named `check` aggregates the 3 other targets. `zinoma check` is equivalent to running `zinoma fmt lint test`.


description: A recipe for Sourcehut CI service. For details, see https://man.sr.ht/builds.sr.ht/manifest.md.

examples: archlinux alpine/latest

package:
cd $site
tar -cvz . > ../site.tar.gz

enum: email webhook

enum: always failure success

required: action condition

required: image tasks


key: image

description: Which OS image to build in. A list of available build images can be found at https://man.sr.ht/builds.sr.ht/compatibility.md


key: arch

description: Which architecture to build for. See https://man.sr.ht/builds.sr.ht/compatibility.md for a list of available architectures.


key: packages

description: A list of packages to install on the image. For image-specific details, consult https://man.sr.ht/builds.sr.ht/compatibility.md


key: repositories

description: A list of extra repositories to enable with the image's package manager. The specific format varies by base image, consult https://man.sr.ht/builds.sr.ht/compatibility.md for details.


key: artifacts

description:
A list of files to extract from the completed build environment and make available for downloading from the jobs page. Artifacts are only uploaded for successful jobs and are pruned after 90 days.
Note that the file names are interpreted literally: do not use ~ or any shell code. If a relative path is used (e.g. example/my-artifact.tar.gz), it will be interpreted relative to the build user's home directory.


key: shell

description: Whether to keep the build VM alive after all of the tasks have finished, even if it doesn't fail, so you can SSH in. You can also SSH in before the tasks have finished and tail the output of the build in your terminal. Learn more at https://man.sr.ht/builds.sr.ht/build-ssh.md


key: sources

description: A list of repositories to clone into the home directory of the build user in the build environment. Optionally, prefix the protocol with the source control management scheme, to specify a protocol other than git. To specify a non-default git revision, append #commit-object to the repository.


key: tasks

description:
A list of scripts to execute in the build environment.
Task names must use only lowercase alphanumeric characters, underscores or dashes and must be <=128 characters in length. Tasks are executed in the order specified.
Each task is run in a separate login session, so if you modify the groups of the build user they will be effective starting from the subsequent task.


key: triggers

description:
A list of triggers to execute post-build, which can be used to send emails or do other post-build tasks.
Learn more at https://man.sr.ht/builds.sr.ht/triggers.md


key: action

description: Trigger type


key: condition

description: When to execute this trigger


key: environment

description: A list of key/value pairs for options to set in the build environment via ~/.buildenv


key: secrets

description: List of secret UUIDs to be added to the guest during the build. Learn more at https://man.sr.ht/builds.sr.ht/#secrets


key: oauth

description: If present, and secrets are enabled for this build, an OAuth 2.0 bearer token is generated for this build with the given string as the list of grants. The acurl command may be used in the task scripts to perform authenticated GraphAL API requests (https://man.sr.ht/graphql.md).


key: addLabels

description: Labels to add to Pull Request.


key: additionalBranchPrefix

description: Additional string value to be appended to `branchPrefix`.


key: additionalReviewers

description: Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it).


key: allowCustomCrateRegistries

description: Set this to `true` to allow custom crate registries.


key: allowPlugins

description: Set this to `true` if repositories are allowed to run install plugins.


key: allowPostUpgradeCommandTemplating

description: Set this to `false` to disable template compilation for post-upgrade commands.


key: allowScripts

description: Set this to `true` if repositories are allowed to run install scripts.


key: allowedPostUpgradeCommands

description: A list of regular expressions that decide which post-upgrade tasks are allowed.


key: ansible

description: Configuration object for the ansible manager


key: ansible-galaxy

description: Configuration object for the ansible-galaxy manager


key: argocd

description: Configuration object for the argocd manager


key: asdf

description: Configuration object for the asdf manager


key: assignAutomerge

description: Assign reviewers and assignees even if the PR is to be automerged.


key: assignees

description: Assignees for Pull Request (either username or email address depending on the platform).


key: assigneesFromCodeOwners

description: Determine assignees based on configured code owners and changes in PR.


key: assigneesSampleSize

description: Take a random sample of given size from `assignees`.


key: autoApprove

description: Set to `true` to automatically approve PRs.


key: autoReplaceGlobalMatch

description: Control whether replacement regular expressions are global matches or only the first match.


key: autodiscover

description: Autodiscover all repositories.


key: autodiscoverFilter

description: Filter the list of autodiscovered repositories.


key: autodiscoverTopics

description: Filter the list of autodiscovered repositories by topics.


key: automerge

description: Whether to automerge branches/PRs automatically, without human intervention.


key: automergeComment

description: PR comment to add to trigger automerge. Only used if `automergeType=pr-comment`.

default: automergeComment


key: automergeSchedule

description: Limit automerge to these times of day or week.


key: automergeStrategy

description: The merge strategy to use when automerging PRs. Used only if `automergeType=pr`.

enum: auto fast-forward merge-commit rebase squash

default: auto


key: automergeType

description: How to automerge, if enabled.

enum: branch pr pr-comment

default: pr


key: azure-pipelines

description: Configuration object for the azure-pipelines manager


key: azureWorkItemId

description: The id of an existing work item on Azure Boards to link to each PR.


key: baseBranches

description: List of one or more custom base branches defined as exact strings and/or via regex expressions.


key: baseDir

description: The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.


key: batect

description: Configuration object for the batect manager


key: batect-wrapper

description: Configuration object for the batect-wrapper manager

versioning: semver


key: bazel

description: Configuration object for the bazel manager


key: bazel-module

description: Configuration object for the bazel-module manager


key: bazelisk

description: Configuration object for the bazelisk manager


key: bbUseDefaultReviewers

description: Use the default reviewers (Bitbucket only).


key: bbUseDevelopmentBranch

description: Use the repository's [development branch](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/#The-branching-model) as the repository's default branch.


key: bicep

description: Configuration object for the bicep manager


key: binarySource

description: Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.

enum: global docker install hermit

default: install


key: bitbucket-pipelines

description: Configuration object for the bitbucket-pipelines manager


key: branchConcurrentLimit

description: Limit to a maximum of x concurrent branches. 0 means no limit, `null` (default) inherits value from `prConcurrentLimit`.


key: branchName

description: Branch name template.


key: branchNameStrict

description: Whether to be strict about the use of special characters within the branch name.


key: branchPrefix

description: Prefix to use for all branch names.

default: renovate/


key: branchPrefixOld

description: Old branchPrefix value to check for existing PRs.


key: branchTopic

description: Branch topic.


key: buildkite

description: Configuration object for the buildkite manager

commitMessageTopic: buildkite plugin {{depName}}


key: bumpVersion

description: Bump the version in the package file being updated.

enum: major minor patch prerelease


key: bundler

description: Configuration object for the bundler manager

versioning: ruby


key: cacheDir

description: The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the `baseDir`.


key: cacheHardTtlMinutes

description: Maximum duration in minutes to keep datasource cache entries.


key: cake

description: Configuration object for the cake manager


key: cargo

description: Configuration object for the cargo manager

commitMessageTopic: Rust crate {{depName}}

versioning: cargo


key: cdnurl

description: Configuration object for the cdnurl manager


key: checkedBranches

description: A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.


key: circleci

description: Configuration object for the circleci manager


key: cloneSubmodules

description: Set to `true` to initialize submodules during repository clone.


key: cloudbuild

description: Configuration object for the cloudbuild manager


key: cocoapods

description: Configuration object for the cocoapods manager


key: commitBody

description: Commit message body template. Will be appended to commit message, separated by two line returns.


key: commitBodyTable

description: If enabled, append a table in the commit message body describing all updates in the commit.


key: commitMessage

description: Message to use for commit messages and pull request titles.

default: {{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}


key: commitMessageAction

description: Action verb to use in commit messages and PR titles.

default: Update


key: commitMessageExtra

description: Extra description used after the commit message topic - typically the version.


key: commitMessageLowerCase

description: Lowercase PR- and commit titles.

enum: auto never


key: commitMessagePrefix

description: Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if `semanticCommits` is enabled.


key: commitMessageSuffix

description: Suffix to add to end of commit messages and PR titles.


key: commitMessageTopic

description: The upgrade topic/noun used in commit messages and PR titles.

default: dependency {{depName}}


key: composer

description: Configuration object for the composer manager

versioning: composer


key: composerIgnorePlatformReqs

description: Configure use of `--ignore-platform-reqs` or `--ignore-platform-req` for the Composer package manager.


key: conan

description: Configuration object for the conan manager

datasource: conan

versioning: conan


key: confidential

description: If enabled, issues created by Renovate are set as confidential.


key: configMigration

description: Enable this to get config migration PRs when needed.


key: configWarningReuseIssue

description: Set this to `false` to make Renovate create a new issue for each config warning, instead of reopening or reusing an existing issue.


key: constraints

description: Configuration object to define language or manager version constraints.


key: constraintsFiltering

description: Perform release filtering based on language constraints.


key: containerbaseDir

description: The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the `cacheDir`.


key: cpanfile

description: Configuration object for the cpanfile manager


key: customDatasources

description: Defines custom datasources for usage by managers

enum: json plain

default: json


key: description

description: A custom description for this configuration object


key: defaultRegistryUrlTemplate

description: Template for generating a defaultRegistryUrl for custom datasource


key: format

description: Format of the custom datasource


key: transformTemplates

description: List of jsonata transformation rules


key: customEnvVariables

description: Custom environment variables for child processes and sidecar Docker containers.


key: customizeDashboard

description: Customize sections in the dependency dashboard issue.


key: defaultRegistryUrls

description: List of registry URLs to use as the default for a datasource.


key: dependencyDashboard

description: Whether to create a "Dependency Dashboard" issue in the repository.


key: dependencyDashboardApproval

description: Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.


key: dependencyDashboardAutoclose

description: Set to `true` to let Renovate close the Dependency Dashboard issue if there are no more updates.


key: dependencyDashboardFooter

description: Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.


key: dependencyDashboardHeader

description: Any text added here will be placed first in the Dependency Dashboard issue body.

default: This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more.


key: dependencyDashboardLabels

description: These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.


description: Control if the Dependency Dashboard issue lists CVEs supplied by [osv.dev](https://osv.dev).

enum: none all unresolved


key: dependencyDashboardTitle

description: Title for the Dependency Dashboard issue.

default: Dependency Dashboard


key: deps-edn

description: Configuration object for the deps-edn manager

versioning: maven


description: Plain text description for a config or preset.


key: detectGlobalManagerConfig

description: If `true`, Renovate tries to detect global manager configuration from the file system.


key: detectHostRulesFromEnv

description: If `true`, Renovate tries to detect host rules from environment variables.


key: digest

description: Configuration to apply when updating a digest (no change in tag/version).

branchTopic: {{{depNameSanitized}}}-digest

commitMessageExtra: to {{newDigestShort}}

commitMessageTopic: {{{depName}}} digest


key: docker-compose

description: Configuration object for the docker-compose manager


key: dockerChildPrefix

description: Change this value to add a prefix to the Renovate Docker sidecar container names and labels.


key: dockerCliOptions

description: Pass CLI flags to `docker run` command when `binarySource=docker`.


key: dockerSidecarImage

description: Change this value to override the default Renovate sidecar image.


key: dockerUser

description: Set the `UID` and `GID` for Docker-based binaries if you use `binarySource=docker`.


key: dockerfile

description: Configuration object for the dockerfile manager


key: draftPR

description: If set to `true` then Renovate creates draft PRs, instead of normal status PRs.


key: droneci

description: Configuration object for the droneci manager


key: dryRun

description: If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.

enum: extract lookup full


key: enabled

description: Enable or disable Renovate bot.


key: enabledManagers

description: A list of package managers to enable. Only managers on the list are enabled.


key: encrypted

description: An object containing configuration encrypted with project key.


key: endpoint

description: Custom endpoint to use.


key: excludeCommitPaths

description: A file matching any of these glob patterns will not be committed, even if the file has been updated.


key: executionTimeout

description: Default execution timeout in minutes for child processes Renovate creates.


key: exposeAllEnv

description: Set this to `true` to allow passing of all environment variables to package managers.


key: extends

description: Configuration presets to use or extend.


key: extractVersion

description: A regex (`re2`) to extract a version from a datasource's raw version string.

format: regex


key: fetchReleaseNotes

description: Controls if and when release notes are fetched.

enum: off branch pr


key: fileMatch

description: RegEx (`re2`) pattern for matching manager files.


key: filterUnavailableUsers

description: Filter reviewers and assignees based on their availability.


key: fleet

description: Configuration object for the fleet manager


key: flux

description: Configuration object for the flux manager


key: followTag

description: If defined, packages will follow this release tag exactly.


key: force

description: Any configuration set in this object will force override existing settings.


key: forceCli

description: Decides if CLI configuration options are moved to the `force` config section.


key: forkModeDisallowMaintainerEdits

description: Disallow maintainers to push to Renovate pull requests when running in fork mode.


key: forkOrg

description: The preferred organization to create or find forked repositories, when in fork mode.


key: forkProcessing

description: Whether to process forked repositories. By default, all forked repositories are skipped when in `autodiscover` mode.

enum: auto enabled disabled


key: forkToken

description: Set a personal access token here to enable "fork mode".


key: fvm

description: Configuration object for the fvm manager


key: git-submodules

description: Configuration object for the git-submodules manager

versioning: git


key: gitAuthor

description: Author to use for Git commits. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).


key: gitIgnoredAuthors

description: Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).


key: gitLabIgnoreApprovals

description: Ignore approval rules for MRs created by Renovate, which is useful for automerge.


key: gitNoVerify

description: Which Git commands will be run with the `--no-verify` option.

enum: commit push

default: commit push


key: gitPrivateKey

description: PGP key to use for signing Git commits.


key: gitTimeout

description: Configure the timeout with a number of milliseconds to wait for a Git task.


key: gitUrl

description: Overrides the default resolution for Git remote, e.g. to switch GitLab from HTTPS to SSH-based.

enum: default ssh endpoint

default: default


key: github-actions

description: Configuration object for the github-actions manager


key: githubTokenWarn

description: Display warnings about GitHub token not being set.


key: gitlabci

description: Configuration object for the gitlabci manager


key: gitlabci-include

description: Configuration object for the gitlabci-include manager


key: globalExtends

description: Configuration presets to use or extend for a self-hosted config.


key: goGetDirs

description: Directory pattern to run `go get` on


key: gomod

description: Configuration object for the gomod manager


key: gradle

description: Configuration object for the gradle manager

versioning: gradle


key: gradle-wrapper

description: Configuration object for the gradle-wrapper manager


key: group

description: Config if `groupName` is enabled.

branchTopic: {{{groupSlug}}}

commitMessageTopic: {{{groupName}}}


key: groupName

description: Human understandable name for the dependency group.


key: groupSlug

description: Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.


key: hashedBranchLength

description: If enabled, branch names will use a hashing function to ensure each branch has that length.


key: helm-requirements

description: Configuration object for the helm-requirements manager

commitMessageTopic: helm chart {{depName}}


key: helm-values

description: Configuration object for the helm-values manager

commitMessageTopic: helm values {{depName}}


key: helmfile

description: Configuration object for the helmfile manager


key: helmsman

description: Configuration object for the helmsman manager


description: Configuration object for the helmv3 manager


key: hermit

description: Configuration object for the hermit manager

versioning: hermit


key: homebrew

description: Configuration object for the homebrew manager

commitMessageTopic: Homebrew Formula {{depName}}


key: hostRules

description: Host rules/configuration including credentials.

default: Bearer


key: description

description: A custom description for this configuration object


key: abortIgnoreStatusCodes

description: A list of HTTP status codes safe to ignore even when `abortOnError=true`.


key: abortOnError

description: If enabled, Renovate aborts its run when HTTP request errors occur.


key: artifactAuth

description: A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`


key: authType

description: Authentication type for HTTP header. e.g. `"Bearer"` or `"Basic"`. Use `"Token-Only"` to use only the token without an authorization type.


key: concurrentRequestLimit

description: Limit concurrent requests per host.


key: dnsCache

description: Enable got DNS cache.


description: Enable got HTTP/2 support.


key: hostType

description: hostType for a package rule. Can be a platform name or a datasource name.


key: insecureRegistry

description: Explicitly turn on insecure Docker registry access (HTTP).


key: keepalive

description: Enable HTTP keepalives for hosts.


key: matchHost

description: A domain name, host name or base URL to match against.


key: maxRequestsPerSecond

description: Limit requests rate per host.


key: timeout

description: Timeout (in milliseconds) for queries to external endpoints.


key: html

description: Configuration object for the html manager


key: ignoreDeprecated

description: Avoid upgrading from a non-deprecated version to a deprecated one.


key: ignoreDeps

description: Dependencies to ignore.


key: ignorePaths

description: Skip any package file whose path matches one of these. Can be a string or glob pattern.


key: ignorePlugins

description: Set this to `true` if `allowPlugins=true` but you wish to skip running plugins when updating lock files.


key: ignorePrAuthor

description: Set to `true` to fetch the entire list of PRs instead of only those authored by the Renovate user.


key: ignorePresets

description: A list of presets to ignore, including any that are nested inside an `extends` array.


key: ignoreReviewers

description: Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).


key: ignoreScripts

description: Set this to `false` if `allowScripts=true` and you wish to run scripts when updating lock files.


key: ignoreTests

description: Set to `true` to enable automerging without tests.


key: ignoreUnstable

description: Ignore versions with unstable SemVer.


key: includeMirrors

description: Whether to process repositories that are mirrors. By default, repositories that are mirrors are skipped.


key: includePaths

description: Include package files only within these defined paths.


key: internalChecksAsSuccess

description: Whether to consider passing internal checks such as `minimumReleaseAge` when determining branch status.


key: internalChecksFilter

description: When and how to filter based on internal checks.

enum: strict flexible none

default: strict


key: jenkins

description: Configuration object for the jenkins manager


key: jsonnet-bundler

description: Configuration object for the jsonnet-bundler manager

datasource: git-tags


key: kotlin-script

description: Configuration object for the kotlin-script manager


key: kubernetes

description: Configuration object for the kubernetes manager


key: kustomize

description: Configuration object for the kustomize manager


key: labels

description: Labels to set in Pull Request.


key: leiningen

description: Configuration object for the leiningen manager


key: lockFileMaintenance

description: Configuration for lock file maintenance.

recreateWhen: always

branchTopic: lock-file-maintenance

commitMessageAction: Lock file maintenance

Change: All locks refreshed


key: logContext

description: Add a global or per-repo log context to each log entry.


key: logFile

description: Log file path.


key: logFileLevel

description: Set the log file log level.

default: debug


key: major

description: Configuration to apply when an update type is `major`.


key: maven

description: Configuration object for the maven manager


key: maven-wrapper

description: Configuration object for the maven-wrapper manager


key: meteor

description: Configuration object for the meteor manager


key: migratePresets

description: Define presets here which have been removed or renamed and should be migrated automatically.


key: minimumReleaseAge

description: Time required before a new release is considered stable.


key: minor

description: Configuration to apply when an update type is `minor`.


key: mint

description: Configuration object for the mint manager


key: mix

description: Configuration object for the mix manager

versioning: hex


key: nix

description: Configuration object for the nix manager

commitMessageTopic: nixpkgs

commitMessageExtra: to {{newValue}}


key: nodenv

description: Configuration object for the nodenv manager

versioning: node


key: npm

description: Configuration object for the npm manager

versioning: npm

Change: [{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})


key: npmToken

description: npm token used to authenticate with the default registry.


key: npmrc

description: String copy of `.npmrc` file. Use `\n` instead of line breaks.


key: npmrcMerge

description: Whether to merge `config.npmrc` with repo `.npmrc` content if both are found.


key: nuget

description: Configuration object for the nuget manager


key: nvm

description: Configuration object for the nvm manager


key: onboarding

description: Require a Configuration PR first.


key: onboardingBranch

description: Change this value to override the default onboarding branch name.

default: renovate/configure


key: onboardingCommitMessage

description: Change this value to override the default onboarding commit message.


key: onboardingConfig

description: Configuration to use for onboarding PRs.


key: onboardingConfigFileName

description: Change this value to override the default onboarding config file name.


key: onboardingNoDeps

description: Onboard the repository even if no dependencies are found.


key: onboardingPrTitle

description: Change this value to override the default onboarding PR title.

default: Configure Renovate


key: onboardingRebaseCheckbox

description: Set to enable rebase/retry markdown checkbox for onboarding PRs.


key: optimizeForDisabled

description: Set to `true` to perform a check for disabled config prior to cloning.


key: osgi

description: Configuration object for the osgi manager


key: osvVulnerabilityAlerts

description: Use vulnerability alerts from `osv.dev`.


key: packageRules

description: Rules for matching packages.

enum:
low
neutral
high
very high

enum: major minor patch pin pinDigest digest lockFileMaintenance rollback bump replacement

default: {{{packageName}}}


key: description

description: A custom description for this configuration object


key: allowedVersions

description: A version range or regex pattern capturing allowed versions for dependencies.


key: customChangelogUrl

description: If set, Renovate will use this URL to fetch changelogs for a matched dependency. Valid only within a `packageRules` object.


key: excludeDepNames

description: Dep names to exclude. Valid only within a `packageRules` object.


key: excludeDepPatterns

description: Dep name patterns to exclude. Valid only within a `packageRules` object.


key: excludePackageNames

description: Package names to exclude. Valid only within a `packageRules` object.


key: excludePackagePatterns

description: Package name patterns to exclude. Valid only within a `packageRules` object.


key: excludePackagePrefixes

description: Package name prefixes to exclude. Valid only within a `packageRules` object.


key: excludeRepositories

description: List of repositories to exclude (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.


key: matchBaseBranches

description: List of strings containing exact matches (e.g. `["main"]`) and/or regex expressions (e.g. `["/^release/.*/"]`). Valid only within a `packageRules` object.


key: matchCategories

description: List of categories to match (for example: `["python"]`). Valid only within a `packageRules` object.


key: matchConfidence

description: Merge confidence levels to match against (`low`, `neutral`, `high`, `very high`). Valid only within `packageRules` object.


key: matchCurrentValue

description: A regex to match against the raw `currentValue` string of a dependency. Valid only within a `packageRules` object.


key: matchCurrentVersion

description: A version or range of versions to match against the current version of a package. Valid only within a `packageRules` object.


key: matchDatasources

description: List of datasources to match (e.g. `["orb"]`). Valid only within a `packageRules` object.


key: matchDepNames

description: Dep names to match. Valid only within a `packageRules` object.


key: matchDepPatterns

description: Dep name patterns to match. Valid only within a `packageRules` object.


key: matchDepTypes

description: List of depTypes to match (e.g. [`peerDependencies`]). Valid only within `packageRules` object.


key: matchFileNames

description: List of strings to do an exact match against package and lock files with full path. Only works inside a `packageRules` object.


key: matchManagers

description: List of package managers to match (e.g. `["pipenv"]`). Valid only within a `packageRules` object.


key: matchPackageNames

description: Package names to match. Valid only within a `packageRules` object.


key: matchPackagePatterns

description: Package name patterns to match. Valid only within a `packageRules` object.


key: matchPackagePrefixes

description: Package name prefixes to match. Valid only within a `packageRules` object.


key: matchRepositories

description: List of repositories to match (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.


key: matchSourceUrlPrefixes

description: A list of source URL prefixes to match against, commonly used to group monorepos or packages from the same organization.


key: matchSourceUrls

description: A list of source URLs to exact match against.


key: matchUpdateTypes

description: Update types to match against (`major`, `minor`, `pin`, `pinDigest`, etc). Valid only within `packageRules` object.


key: replacementName

description: The name of the new dependency that replaces the old deprecated dependency.


key: replacementNameTemplate

description: Controls what the replacement package name.


key: replacementVersion

description: The version of the new dependency that replaces the old deprecated dependency.


key: password

description: Password for authentication.


key: patch

description: Configuration to apply when an update type is `patch`.


description: Configuration object for the pep621 manager


key: persistRepoData

description: If set to `true`: keep repository data between runs instead of deleting the data.


key: pin

description: Configuration to apply when an update type is `pin`.

rebaseWhen: behind-base-branch

groupName: Pin Dependencies

groupSlug: pin-dependencies

commitMessageAction: Pin

commitMessageTopic: dependencies


key: pinDigest

description: Configuration to apply when pinning a digest (no change in tag/version).


key: pinDigests

description: Whether to add digests to Dockerfile source images.


key: pip-compile

description: Configuration object for the pip-compile manager

branchTopic: pip-compile-refresh

commitMessageAction: Refresh pip-compile outputs


description: Configuration object for the pip_requirements manager


description: Configuration object for the pip_setup manager


key: pipenv

description: Configuration object for the pipenv manager


key: platform

description: Platform type of repository.

enum: azure bitbucket bitbucket-server codecommit gitea github gitlab local

default: github


key: platformAutomerge

description: Controls if platform-native auto-merge is used.


key: platformCommit

description: Use platform API to perform commits instead of using Git directly.


key: poetry

description: Configuration object for the poetry manager


key: postUpdateOptions

description: Enable post-update options to be run after package/artifact updating.

enum: bundlerConservative gomodMassage gomodTidy gomodTidy1.17 gomodTidyE gomodUpdateImportPaths helmUpdateSubChartArchives npmDedupe pnpmDedupe yarnDedupeFewer yarnDedupeHighest


key: postUpgradeTasks

description: Post-upgrade tasks that are executed before a commit is made by Renovate.

executionMode: update

enum: update branch

default: update


key: description

description: A custom description for this configuration object


key: commands

description: A list of post-upgrade commands that are executed before a commit is made by Renovate.


key: executionMode

description: Controls when the post upgrade tasks run: on every update, or once per upgrade branch.


key: fileFilters

description: Files that match the glob pattern will be committed after running a post-upgrade task.


key: prBodyColumns

description: List of columns to use in PR bodies.

default: Package Type Update Change Pending


key: prBodyDefinitions

description: Table column definitions to use in PR tables.

Package: {{{depNameLinked}}}

Type: {{{depType}}}

Update: {{{updateType}}}

Current value: {{{currentValue}}}

New value: {{{newValue}}}

Pending: {{{displayPending}}}

References: {{{references}}}

Package file: {{{packageFile}}}


key: prBodyNotes

description: List of extra notes or templates to include in the Pull Request body.


key: prBodyTemplate

description: Pull Request body template. Controls which sections are rendered in the body of the pull request.


key: prCommitsPerRunLimit

description: Set the maximum number of commits per Renovate run. By default there is no limit.


key: prConcurrentLimit

description: Limit to a maximum of x concurrent branches/PRs. 0 means no limit.


key: prCreation

description: When to create the PR for a branch.

enum: immediate not-pending status-success approval

default: immediate


key: prFooter

description: Text added here will be placed last in the PR body, with a divider separator before it.

default: This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).


key: prHeader

description: Text added here will be placed first in the PR body.


key: prHourlyLimit

description: Rate limit PRs to maximum x created per hour. 0 means no limit.


key: prNotPendingHours

description: Timeout in hours for when `prCreation=not-pending`.


key: prPriority

description: Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last.


key: prTitle

description: Pull Request title template (deprecated). Inherits from `commitMessage` if null.


key: prTitleStrict

description: Whether to bypass appending extra context to the Pull Request title.


key: pre-commit

description: Configuration object for the pre-commit manager

commitMessageTopic: pre-commit hook {{depName}}

prBodyNotes: Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://github.com/renovatebot/renovate/discussions/new) if you have any questions.


key: printConfig

description: If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.


key: privateKey

description: Server-side private key.


key: privateKeyOld

description: Secondary or old private key to try.


key: privateKeyPath

description: Path to the Server-side private key.


key: privateKeyPathOld

description: Path to the Server-side old private key.


key: productLinks

description: Links which are used in PRs, issues and comments.


key: pruneBranchAfterAutomerge

description: Set to `true` to enable branch pruning after automerging.


key: pruneStaleBranches

description: Set to `false` to disable pruning stale branches.


key: pub

description: Configuration object for the pub manager


key: puppet

description: Configuration object for the puppet manager


key: pyenv

description: Configuration object for the pyenv manager

versioning: docker


key: rangeStrategy

description: Determines how to modify or update existing ranges.

enum: auto pin bump replace widen update-lockfile in-range-only

default: auto


key: rebaseLabel

description: Label to request a rebase from Renovate bot.

default: rebase


key: rebaseWhen

description: Controls when Renovate rebases an existing branch.

enum: auto never conflicted behind-base-branch


key: recreateWhen

description: Recreate PRs even if same ones were closed previously.

enum: auto always never


key: redisUrl

description: If set, this Redis URL will be used for caching instead of the file system.


key: regex

description: Configuration object for the regex manager


key: regexManagers

description: Custom managers using regex matching.

enum: any recursive combination

default: any


key: description

description: A custom description for this configuration object


key: autoReplaceStringTemplate

description: Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.


key: currentValueTemplate

description: Optional `currentValue` for extracted dependencies. Valid only within a `regexManagers` object.


key: customType

description: Custom manager to use. Valid only within a `regexManagers` object.


key: datasourceTemplate

description: Optional datasource for extracted dependencies. Valid only within a `regexManagers` object.


key: depNameTemplate

description: Optional depName for extracted dependencies. Valid only within a `regexManagers` object.


key: depTypeTemplate

description: Optional `depType` for extracted dependencies. Valid only within a `regexManagers` object.


key: extractVersionTemplate


key: matchStrings

description: Regex capture rule to use. Valid only within a `regexManagers` object.


key: matchStringsStrategy

description: Strategy how to interpret matchStrings.


key: packageNameTemplate

description: Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `regexManagers` object.


key: registryUrlTemplate

description: Optional registry URL for extracted dependencies. Valid only within a `regexManagers` object.


key: versioningTemplate

description: Optional versioning for extracted dependencies. Valid only within a `regexManagers` object.


key: registryAliases

description: Aliases for registries.


key: registryUrls

description: List of URLs to try for dependency lookup. Package manager specific.


key: replacement

description: Configuration to apply when replacing a dependency.

branchTopic: {{{depNameSanitized}}}-replacement

commitMessageAction: Replace

commitMessageExtra: with {{newName}} {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{#if isSingleVersion}}{{{prettyNewVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}

prBodyNotes: This is a special PR that replaces `{{{depNameSanitized}}}` with the community suggested minimal stable replacement version.


key: repositories

description: List of Repositories.


key: repositoryCache

description: This option decides if Renovate uses a JSON cache to speed up extractions.

enum: disabled enabled reset

default: disabled


key: repositoryCacheType

description: Set the type of renovate repository cache if `repositoryCache` is enabled.

default: local


key: requireConfig

description: Controls Renovate's behavior regarding repository config files such as `renovate.json`.

enum: required optional ignored

default: required


key: respectLatest

description: Ignore versions newer than npm "latest" version.


key: reviewers

description: Requested reviewers for Pull Requests (either username or email address depending on the platform).


key: reviewersFromCodeOwners

description: Determine reviewers based on configured code owners and changes in PR.


key: reviewersSampleSize

description: Take a random sample of given size from `reviewers`.


key: rollback

description: Configuration to apply when rolling back a version.

branchTopic: {{{depNameSanitized}}}-rollback

commitMessageAction: Roll back

semanticCommitType: fix


key: rollbackPrs

description: Create PRs to roll back versions if the current version is not found in the registry.


key: ruby-version

description: Configuration object for the ruby-version manager


key: sbt

description: Configuration object for the sbt manager

versioning: ivy


key: schedule

description: Limit branch creation to these times of day or week.


key: secrets

description: Object which holds secret name/value pairs.


key: semanticCommitScope

description: Commit scope to use if Semantic Commits are enabled.

default: deps


key: semanticCommitType

description: Commit type to use if Semantic Commits is enabled.

default: chore


key: semanticCommits

description: Enable Semantic Commit prefixes for commits and PR titles.


key: separateMajorMinor

description: If set to `false`, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.


key: separateMinorPatch

description: If set to `true`, Renovate will separate `minor` and `patch` updates into separate branches.


key: separateMultipleMajor

description: If set to `true`, PRs will be raised separately for each available `major` upgrade version.


key: setup-cfg

description: Configuration object for the setup-cfg manager


key: skipInstalls

description: Skip installing modules/dependencies if lock file updating is possible without a full install.


key: stopUpdatingLabel

description: Label to make Renovate stop updating a PR.

default: stop-updating


key: suppressNotifications

description: Options to suppress various types of warnings and other notifications.

enum: artifactErrors branchAutomergeFailure configErrorIssue dependencyLookupWarnings deprecationWarningIssues lockFileErrors missingCredentialsError onboardingClose prEditedNotification prIgnoreNotification


key: swift

description: Configuration object for the swift manager

versioning: swift


key: tekton

description: Configuration object for the tekton manager


key: terraform

description: Configuration object for the terraform manager

commitMessageTopic: Terraform {{depName}}


key: terraform-version

description: Configuration object for the terraform-version manager

versioning: hashicorp


key: terragrunt

description: Configuration object for the terragrunt manager

commitMessageTopic: Terragrunt dependency {{depName}}


key: terragrunt-version

description: Configuration object for the terragrunt-version manager


key: tflint-plugin

description: Configuration object for the tflint-plugin manager

commitMessageTopic: TFLint plugin {{depName}}


key: timezone

description: [IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)


key: token

description: Repository Auth Token.


key: transitiveRemediation

description: Enable remediation of transitive dependencies.


key: travis

description: Configuration object for the travis manager


key: unicodeEmoji

description: Enable or disable Unicode emoji.


key: updateInternalDeps

description: Whether to update internal dep versions in a monorepo. Works on Lerna or Yarn Workspaces.


key: updateLockFiles

description: Set to `false` to disable lock file updating.


key: updateNotScheduled

description: Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule.


key: updatePinnedDependencies

description: Whether to update pinned (single version) dependencies or not.


key: useBaseBranchConfig

description: Whether to read configuration from `baseBranches` instead of only the default branch.


key: userStrings

description: User-facing strings for the Renovate comment when a PR is closed.

ignoreTopic: Renovate Ignore Notification

ignoreMajor: Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for *any* future {{{newMajor}}}.x releases. But if you manually upgrade to {{{newMajor}}}.x then Renovate will re-enable `minor` and `patch` updates automatically.

ignoreDigest: Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for the `{{{depName}}}` `{{{newDigestShort}}}` update again.

ignoreOther: Because you closed this PR without merging, Renovate will ignore this update ({{{newValue}}}). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config.


key: username

description: Username for authentication.


key: velaci

description: Configuration object for the velaci manager


key: versioning

description: Versioning to use for filtering and comparisons.

enum: aws-machine-image azure-rest-api bazel-module cargo composer conan deb debian docker git go-mod-directive gradle hashicorp helm hermit hex ivy kubernetes-api loose maven nixpkgs node npm nuget pep440 perl poetry python redhat regex rez ruby semver semver-coerced swift ubuntu

pattern: ^regex:


key: vulnerabilityAlerts

description: Config to apply when a PR is needed due to a vulnerability in the existing package version.

rangeStrategy: update-lockfile

commitMessageSuffix: [SECURITY]

prCreation: immediate


key: woodpecker

description: Configuration object for the woodpecker manager


key: writeDiscoveredRepos

description: Writes discovered repositories to a JSON file and then exit.


key: cjs

description: A boolean or object for toggling CJS features in ESM


key: cache

description: A boolean for storing ES modules in require.cache


key: esModule

description: A boolean for __esModule interoperability


key: extensions

description: A boolean for respecting require.extensions in ESM


key: mutableNamespace

description: A boolean for importing named exports of CJS modules


key: namedExports


key: paths

description: A boolean for following CJS path rules in ESM


key: vars

description: A boolean for __dirname, __filename, and require in ESM


key: dedefault

description: A boolean for requiring ES modules without the dangling require().default


key: topLevelReturn

description: A boolean for top-level return support


key: mainFields

description: An array of fields checked when importing a package


key: items

description: Fields from package.json


key: mode

description: A string describing the mode in which to detect ESM module files

const: auto

const: all

const: strict


description: 'auto' detect files with import, import.meta, export, 'use module', or .mjs as ESM


description: 'all' files besides those with 'use script' or .cjs are treated as ESM


description: 'strict to treat only .mjs files as ESM


key: await

description: A boolean for top-level await in modules without ESM exports. (Node 10+)


key: force

description: A boolean to apply these options to all module loads


key: wasm

description: A boolean for WebAssembly module support. (Node 8+)


description: [dev] A boolean for toggling cache creation or a cache directory path


key: sourceMap

description: [dev] A boolean for including inline source maps


description: Config defines the configuration

group: repo

group_name: Source: Helm Repository

group: path

group_name: Source: Local Filesystem

group: git

group_name: Source: Git Repository

default: deploy

group: execution

group_name: Execution

required: Key Operator Value Effect TolerationSeconds


key: enabled

description: Enabled can be used to enable attaching to a container


key: disableReplace

description:
DisableReplace prevents DevSpace from actually replacing the pod with modifications so that
the pod starts up correctly.


key: disableTTY

description: DisableTTY is used to tell DevSpace to not use a TTY connection for attaching


key: BandwidthLimits

description: BandwidthLimits defines the struct for specifying the sync bandwidth limits