description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.

enum: cover contain

type: string


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: config

description: Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp)

type: object


key: hooks

description: Configuration for scripts to run to hook into the publish process

type: array


key: experiments

description: Enable experimental features that may be unstable, unsupported, or removed without deprecation notices.

type: boolean


key: turboModules

description: Enables Turbo Modules, which are a type of native modules that use a different way of communicating between JS and platform code. When installing a Turbo Module you will need to enable this experimental option (the library still needs to be a part of Expo SDK already, like react-native-reanimated v2). Turbo Modules do not support remote debugging and enabling this option will disable remote debugging.


key: jsEngine

description: Sets the JS Engine that will interpret your code

enum: hermes jsc


description: Internal properties for developer tools


key: pluginHistory

description: List of plugins already run on the config


enum: clojure haskell kotlin qbasic forth lolcode brainf*** emoticon bloop react_native unlambda javascript babel coffeescript scheme apl lua python ruby roy php python3 nodejs enzyme go java cpp cpp11 c csharp fsharp web_project html rust swift python_turtle basic jest django express sinatra rails rlang nextjs gatsbyjs reactjs reactts reactre flow bash quil polygott crystal julia perl6 elixir nim dart gatsbyjsv2 reason_nodejs tcl erlang typescript ocaml pygame love2d reason Tkinter tkinter java_swing php_server nodejs_prybar elisp php7 sqlite java10 php_cli nodejs_beta pyxel static go_beta nodejs_static python3_beta raku testj wasm java10_beta python_beta html_beta testj_beta scala riddlejs java_maven

enum: python-python3-poetry python-python2-poetry nodejs-npm nodejs-yarn ruby-bundler elisp-cask dart-pub java-maven rlang dotnet rust

authors: Emily Grace Seville (https://github.com/EmilySeville7cfg)


key: run

description: Command to run REPL


key: language

description: Language name used in REPL


key: audio

description: Enable/disable system-wide audio in REPL


key: packager

description: Universal Package Manager (UPM) configuration


key: afterInstall

description: Command to run on new package install


key: ignoredPaths

description: List of ignored path


key: ignoredPackages

description: List of ignored packages


description: Language name


key: features

description: Universal Package Manager (UPM) features


key: packageSearch

description: Enable/disable package search panel


key: guessImports

description: Enable/disable guessing required packages


key: languages

description: Language configuration


description: Language configuration


key: glob

description: Glob for language files


key: languageServer

description: Language Server Protocol (LSP) configuration


key: start

description: Command to run server


key: author

description: List of names of authors of the cog


key: description

description: A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info.


description: The message that gets displayed when a cog is installed or a repo is added


key: short

description: A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list


description: A statement explaining what end user data the cog is storing. This is displayed when a user executes [p]cog info. If the statement has changed since last update, user will be informed during the update.


description: Min version number of Red in the format MAJOR.MINOR.MICRO


description: Max version number of Red in the format MAJOR.MINOR.MICRO, if min_bot_version is newer than max_bot_version, max_bot_version will be ignored


description: Min version number of Python in the format [MAJOR, MINOR, PATCH]

type: integer


key: hidden

description: Determines if a cog is visible in the cog list for a repo.


key: disabled

description: Determines if a cog is available for install.


description: A dict of required cogs that this cog depends on in the format {cog_name : repo_url}. Downloader will not deal with this functionality but it may be useful for other cogs.


key: requirements

description: List of required libraries that are passed to pip on cog install.


key: tags

description: A list of strings that are related to the functionality of the cog. Used to aid in searching.


key: type

description: Optional, defaults to COG. Must be either COG or SHARED_LIBRARY. If SHARED_LIBRARY then hidden will be True.


description: A rule-set and config for the Solidarity JSON checker

type: string integer

enum: darwin macos freebsd linux sunos win32 windows

required: rule binary

enum: dir directory

required: rule location

required: rule variable

required: rule match

required: rule plugin name


key: cli

description: CLI Rule


key: dir

description: Dir Rule


key: file

description: File Rule


key: env

description: ENV Rule


key: shell

description: Shell Rule


key: match

description: A regexp to search the output.


key: custom

description: Custom Rule


key: output

description: Identify what kind output should happen when a check is called

enum: moderate verbose silent


description: List of requirement rules for your particular environment


description: You can add a sponsor button in your repository to increase the visibility of funding options for your open source project.

type: string array null

format: uri-reference


Project name on CommunityBridge.


key: github

description: Username or usernames on GitHub.


key: issuehunt

description: Username on IssueHunt.


Username on Ko-fi.


key: liberapay

description: Username on Liberapay.


Username on Open Collective.


key: otechie

description: Username on Otechie.


key: patreon

description: Username on Pateron.


key: tidelift

description: Platform and package on Tidelift.


description: Link or links where funding is accepted on external locations.


key: items

description: Link to an external location.


description: JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.

required: detachedManifestFileId files

required: compatibility instructions files createdDateTime

required: handler files

required: type detachedManifestFileId

Toaster

provider: Microsoft

deviceManufacturer: Microsoft

deviceModel: Toaster

required: updateId manifestVersion


key: miniUpdateManifest

description: Manifest containing metadata of the detached, downloadable, complete update manifest.


key: files

description: Map of '#/definitions/fileId' to file metadata.


key: fullUpdateManifest

description: Full update manifest containing metadata of the update being deployed.


key: createdDateTime

description: Date & time update was created in ISO 8601 format.


key: fileId

description: Server generated file identifier to be used for retrieving file metadata and download URL.


key: inlineStep

description: Installation instruction step that performs code execution.


description: 'fileId' of update files that agent will pass to handler.


key: referenceStep

description: Installation instruction step that installs another update.


key: $schema

description: JSON schema reference


description: A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.0.0

default: locale

const: locale

required: PackageIdentifier PackageVersion PackageLocale ManifestType ManifestVersion


key: Url

description: Optional Url type


key: Tag

description: Package moniker or tag


key: PackageIdentifier

description: The package unique identifier


key: PackageVersion

description: The package version


key: PackageLocale

description: The package meta-data locale


key: Publisher

description: The publisher name


key: PublisherUrl

description: The publisher home page


key: PublisherSupportUrl

description: The publisher support page


key: PrivacyUrl

description: The publisher privacy page or the package privacy page


key: Author

description: The package author


key: PackageName

description: The package name


key: PackageUrl

description: The package home page


key: License

description: The package license


key: LicenseUrl

description: The license page


key: Copyright

description: The package copyright


key: CopyrightUrl

description: The package copyright page


key: ShortDescription

description: The short package description


key: Description

description: The full package description


key: Moniker

description: The most common package term


key: Tags

description: List of additional package search terms


key: ManifestType

description: The manifest type


key: ManifestVersion

description: The manifest syntax version


description: Schema for import manifest used for importing an update to Device Update for IoT Hub.

required: type updateId

required: updateId compatibility instructions manifestVersion createdDateTime


key: instructions

description: Update installation instructions.


key: stepDescription

description: Optional instruction step description.


key: inlineStep


key: files

description: Names of update files that agent will pass to handler.


key: referenceStep


key: examples

description: Example update


key: steps

description: pre-install script

arguments: --pre-install


key: $schema

description: JSON schema reference.


key: description

description: Optional update description.


description: List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.


key: manifestVersion

description: Import manifest schema version. Must be 5.0.


key: createdDateTime

description: Date & time import manifest was created in ISO 8601 format.


description: The event horizon server configuration

type: number

required: interaction management


key: interaction

description: The configuration for the interaction server


key: enabled

description: Whether or not the interaction server is enabled


key: port

description: The port to use for exposing the interaction server


key: unixSocket

description: The unix socket to use for exposing the interaction server on


description: The port to use for exposing the management server


description: The unix socket to use for exposing the management server on


key: restrict access

description: This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the "administer filters" and "bypass node access" permissions provided by Drupal core).


description: A mcmeta file for an animated texture for a Minecraft resource pack config schema


key: animation

description: Animation


description: shopware cli extension configuration definition file

enum: German International

enum: Administration SEOOptimierung Bonitaetsprüfung Rechtssicherheit Auswertung KommentarFeedback Tracking Integration PreissuchmaschinenPortale Warenwirtschaft Versand Bezahlung StorefrontDetailanpassungen Sprache Suche HeaderFooter Detailseite MenueKategorien Bestellprozess KundenkontoPersonalisierung Sonderfunktionen Themes Branche Home+Furnishings FashionBekleidung GartenNatur KosmetikGesundheit EssenTrinken KinderPartyGeschenke SportLifestyleReisen TechnikIT IndustrieGroßhandel MigrationTools Einkaufswelten ConversionOptimierung Extensions MarketingTools B2BExtensions Blog emailMarketing promotionsAndVoucher loyalityAndRewards recommendations otherMarketingCommercials socialCommerce middlewareAndConnectors pim dam cms crm personalization

enum: extension theme

required: file priority

required: question answer


description: Enables the changelog generation.


description: Enables the changelog generation with OpenAI (Requires OPENAI_TOKEN environment variable).


key: pattern

description: Limit with RegEx which commits should be considered for the changelog generation.


key: template

description: Allows to override the Go template which renders the Changelog.


key: variables

description: Allows to write RegEx groups into variables which can be used in the template.


key: shopwareVersionConstraint

description: Overrides the shopware version constraint in the composer.json/manifest.xml file.


key: icon

description: Specifies the Path to the icon (128x128 px) for store.


key: availabilities

description: Specifies the visibility in stores.


key: localizations

description: Specifies the languages the extension is translated.


key: categories

description: Specifies the categories in which the extension can be found.


key: type

description: Specifies the type of this extension.


description: Specifies whether the extension should automatically be set compatible with Shopware bugfix versions.


key: videos

description: Specifies the links of YouTube-Videos to show or describe the extension.


key: tags

description: Specifies the tags of the extension.


key: highlights

description: Specifies the highlights of the extension.


key: features

description: Specifies the features of the extension.


key: faq

description: Specifies Frequently Asked Questions for the extension.


key: description

description: Specifies the description of the extension in store.


key: de

description: Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_de.md`


key: en

description: Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_en.md`


description: Installation manual of the extension in store.


key: images

description: Specifies images for the extension in the store.


key: file

description: File path to image relative from root of the extension


key: activate

description: Specifies whether the image is active in the language.


key: preview

description: Specifies whether the image is a preview in the language.


key: priority

description: Specifies the order of the image ascending the given priority.


description: IfState 1.8.2 Configuration Schema

examples: ^br-[\da-f]{12} ^docker\d+ ^lo$ ^ppp\d+$ ^veth ^virbr\d+ ^vrrp\d*\.\d+$

type: integer string

default: boot

default: main

enum: to_tbl blackhole unreachable prohibit

default: unspec

enum: up down

enum: gred hhf mqprio multiq netem pfifo_fast pie red sfb sfq tbf

required: kind limit min max avpkt burst probability

enum: flowblind srchost dsthost hosts flows dual-srchost dual-dsthost triple-isolated

enum: datacentre lan metro regional internet oceanic satellite interplanetary

enum: 0 balance-rr 1 active-backup 2 balance-xor 3 broadcast 4 802.3ad 5 balance-tlb 6 balance-alb

enum: drv probe link timer ifdown ifup rx_err tx_err tx_queued intr tx_done rx_status pktdata hw wol

enum: src dst proto proto-src proto-dst iif priority mark nfct nfct-src nfct-dst nfct-proto-src nfct-proto-dst rt-classid sk-uid sk-gid vlan-tag rxhash

enum: unicast local broadcast anycast multicast blackhole unreachable prohibit throw nat xresolve


key: ignore-ipaddr

description: list of ip address prefixes to be ignored


key: items

description: ip address with prefix length


key: ignore-ifname

description: interface names matching this list of regex will be ignored


description: regex to match interface name


key: ignore-routes

description: filter routes by options


key: ignore-rules

description: filter rules by options


key: action

description: the type of this rule


description: the priority of this rule


key: from

description: select the source prefix to match


key: to

description: select the destination prefix to match


key: iif

description: select the incoming device to match


key: oif

description: select the outgoing device to match


key: proto

description: routing protocol number (`/etc/iproute2/rt_protos`)


key: fwmark

description: select the *fwmark* value to match


key: ipproto

description: select the ip protocol to match


description: link mac address (xx:xx:xx:xx:xx:xx)


description: specifies a device group name or index


description: specifies a parent device name or index


description: specifies a master device name or index


description: change the mtu of the device


description: set device state


description: the transmit queue length of the device


description: symbolic name for easy reference


description: remote IPv4 address of the tunnel


description: local IPv4 address of the tunnel


interface to use for tunnel endpoint communication


key: iface-sysctl

description: configures [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)


description: settings in `/proc/sys/net/ipv4/*/conf/`


description: settings in `/proc/sys/net/ipv6/*/conf/`


description: qdisc id


description: protocol selector


description: priority


description: traffic control queueing discipline

const: choke

const: codel

enum: bfifo pfifo

const: fq

enum: atm cbq drr dsmark hfsc htb prio qfq

required: kind children

const: mq


key: handle

description: unique id


description: generic classless qdisc


key: kind

description: qdisk type


description: [choke](https://man7.org/linux/man-pages/man8/tc-choke.8.html) - choose and keep scheduler


description: qdisk type


description: [CoDel](https://man7.org/linux/man-pages/man8/tc-codel.8.html) - Controlled-Delay Active Queue Management algorithm


description: qdisk type


description: [bfifo](https://man7.org/linux/man-pages/man8/tc-bfifo.8.html) - Byte limited First In, First Out queue; [pfifo](https://man7.org/linux/man-pages/man8/tc-pfifo.8.html) - Packet limited First In, First Out queue


description: qdisk type


key: limit

description: queue size in bytes or packets


description: [fq](https://man7.org/linux/man-pages/man8/tc-fq.8.html) - Fair Queue traffic policing


description: qdisk type


description: hard limit on the real queue size (number of packets)


description: hard limit on the max number of packets per flow


description: [fq_codel](https://man7.org/linux/man-pages/man8/tc-fq_codel.8.html) - Fair Queuing (FQ) with Controlled Delay (CoDel)


description: qdisk type


key: flows

description: number of flows


description: generic classful qdisc


description: qdisk type


description: classful multiqueue dummy scheduler


description: qdisk type


key: children

description: list child qdiscs for each device TX queue


key: items

description: child qdiscs for the nth device TX queue


key: tc-cake

description: [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) - common applications kept enhanced (CAKE)

const: cake

type: boolean string


description: qdisk type


description: unique id


description: ACKnowledge filter


description: ATM mode


key: autorate

description: autorate-ingress


description: diffserv mode


key: ingress

description: ingress


key: overhead

description: overhead


description: flow mode


description: fwmark


key: memlimit

description: memlimit


key: mpu

description: MPU


key: nat

description: NAT


key: raw

description: RAW


key: rtt

description: well-known RTT


description: manually specify an RTT (us)


description: split GSO


key: target

description: target


key: wash

description: wash


description: traffic control filter action

const: mirred

required: direction action dev

enum: ingress egress

enum: mirror redirect


description: [mirred](https://man7.org/linux/man-pages/man8/tc-mirred.8.html) - mirror/redirect action


key: direction

description: packet direction


key: action

description: copy (`mirror`) or move (`redirect`) packets to the destination interface


key: dev

description: destination interface where packets are redirected or mirrored to


key: index

description: unique action ID


key: mode

description: force attach mode of the XDP program (`auto`: let the kernel choose, `xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)

enum: auto xdp xdpgeneric xdpoffload

default: auto


description: allowed attach modes of the XDP program (`xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)

enum: xdp xdpgeneric xdpoffload


key: options

description: global configuration settings


key: all

description: overrides [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/all/`


key: default

description: default [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/default/`


key: ignore

description: ignore patterns to skip interface, ip address or routing objects


description: ignore dynamic assigned ip addresses


key: bpf

description: load and pin eBPF programs (i.e. for XDP)

required: object section


description: BPF program


key: object

description: BPF ELF file to load


key: section

description: BPF program's section name


key: cshaper

description: cshaper templates

required: search replace


description: cshaper profile


description: build a ifb ifname using a regex on the ifname


key: search

description: pattern to search


key: replace

description: replace pattern by string


key: interfaces

description: list of interface settings (link settings and ip addresses)

required: name type states

enum: instance group

enum: unknown fault backup master

const: ifb

const: ipoib

const: ipvlan

const: macvlan

const: macvtap

const: team

const: tun

default: tap

enum: 1 tun 2 tap

type: boolean integer

const: vrf

const: vti

const: bond

default: balance-rr

enum: 0 any 1 all

default: any

enum: 0 always 1 better 2 failure

default: always

enum: 0 slow 1 fast

default: slow

enum: 0 stable 1 bandwidth 2 count

default: stable

const: bridge

required: kind peer

enum: veth vxcan

required: kind link vlan_id

const: vlan

const: vxlan

const: ipip

const: sit

enum: gre gretap

const: geneve

const: wireguard

const: xfrm


key: name

description: name of the interface


key: addresses

description: ip addresses of the interface


key: brport

description: settings for bridge ports


key: priority

description: set port priority


key: cost

description: set port cost


key: guard

description: filter BPDU packets


key: mode

description: enable hairpin mode


description: enable multicast fast leave


key: protect

description: prevent to become a root port


key: learning

description: allow MAC address learning


description: flood unknown unicasts


description: flood broadcasts


description: flood multicasts


description: clone multicast packets into unicasts


key: proxyarp

description: enable proxy ARP


description: enable proxy ARP (IEEE 802.11 and Hotspot 2.0)


description: ARP and ND suppression


description: VLAN to tunnel mapping


backup bridge port on loss carrier


key: isolated

description: isolated port, can communicate only with non-isolated ports


key: vrrp

description: interface depending on vrrp status


description: related vrrp INSTANCE or GROUP name


key: type

description: failover type


key: states

description: states at which the interface should be configured


key: link

description: link settings of the interface

const: ifb

const: ipoib

enum: 0 balance-rr 1 active-backup 2 balance-xor 3 broadcast 4 802.3ad 5 balance-tlb 6 balance-alb


description: Intermediate Functional Block device


key: kind

description: link type


description: Virtual tunnel interface IPv4|IPv6 over IPv6


description: link type


description: IP over Infiniband device


description: link type


description: Interface for L3 (IPv6/IPv4) based VLANs

const: ipvlan


description: link type


description: Virtual interface base on link layer address (MAC)

const: macvlan


description: link type


description: Virtual interface based on link layer address (MAC) and TAP

const: macvtap


description: link type


description: Team network device

const: team


description: link type


description: Virtual software device (TUN/TAP)

const: tun


description: link type


description: device mode (Ethernet headers)


description: provide packet information


description: persistent device; non-persistent devices cannot be created


prepend frames with struct virtio_net_hdr


description: enable multiqueue tuntap


description: device owner


description: device group


description: Virtual Routing and Forwarding device

const: vrf


description: link type


description: Virtual tunnel interface over IPv4

const: vti


description: link type


description: Virtual tunnel interface over IPv6


description: link type


description: Bonding network interface

const: bond


description: link type


description: the bonding policy


description: MII link monitoring frequency in milliseconds


description: time, in milliseconds, to wait before enabling a slave after a link recovery has been detected


description: time, in milliseconds, to wait before disabling a slave after a link failure has been detected


use MII or ETHTOOL ioctls vs. netif_carrier_ok() to determine the link status


description: ARP link monitoring frequency in milliseconds


arp validation for arp monitoring


description: quantity of arp_ip_targets that must be reachable


description: reselection policy for the primary slave


slave mac address selection


transmit hash policy to use for slave selection


description: number of IGMP membership reports to be issued after a failover event


dropped (0) or delivered (1) duplicate frames


description: number of links that must be active before asserting carrier


description: number of seconds between instances where the bonding driver sends learning packets to each slaves peer switch


description: number of packets to transmit through a slave before moving to the next one


description: requested LACPDU packet rate in 802.3ad mode


description: 802.3ad aggregation selection logic to use


dynamic shuffling of flows in tlb mode


description: Bridge network interface

const: bridge


description: link type


description: FDB entry ageing time in milliseconds


802.1q or 802.1ad (Q-in-Q)


description: Physical network interface


description: link type


key: permaddr

description: select interface by permanent address [ethtool -P]


key: businfo

description: select interface by bus info [ethtool -i]


description: Dummy network interface


description: VETH/VXCAN interface


description: link type


description: VLAN interface

const: vlan


description: link type


specifies the VLAN identifier to use


description: VXLAN interface

const: vxlan


description: link type


specifies the VNI


description: IPIP interface

const: ipip


description: link type


description: SIT interface

const: sit


description: link type


description: GRE, GRETAP interface


description: link type


description: IP6GRE, IP6GRETAP interface


description: link type


description: GENEVE interface over IPv4

const: geneve


description: link type


specifies the VNI to use


description: GENEVE interface over IPv6


description: WireGuard interface; WireGuard settings can be configured using a `wireguard` block

const: wireguard


description: link type


description: XFRM interface

const: xfrm


description: link type


underlying interface used to send and receive the transformed traffic


lookup key to match xfrm policies


key: neighbours

description: static ARP or NDISC cache entries


key: dst

description: protocol address of the neighbour


key: lladdr

description: link layer address of the neighbour


key: sysctl

description: [interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/{IFACE}/`


key: ethtool

description: network driver and hardware settings via [ethtool(8)](https://man7.org/linux/man-pages/man8/ethtool.8.html)

enum: half full

enum: tp aui bnc mii

enum: internal external

pattern: ^[pumbagsfd]+$

enum: drv probe link timer ifdown ifup rx_err tx_err tx_queued intr tx_done rx_status pktdata hw wol

type: string array

enum: auto off RS BaseR LLRS

enum: auto RS BaseR LLRS


key: pause

description: pause parameters


key: autoneg

description: enable pause autonegotiation


key: rx

description: enable Rx pause


key: tx

description: enable Tx pause


key: coalesce

description: interrupt coalescing


key: ring

description: rx/tx ring parameters


description: number of ring entries for the Rx ring


key: rx-mmini

description: number of ring entries for the Rx Mini ring


key: rx-jumbo

description: number of ring entries for the Rx Jumbo ring


description: number of ring entries for the Tx ring


key: features

description: offload parameters and other features


description: enable RX checksumming


description: enable TX checksumming


key: sg

description: enable scatter-gather


key: tso

description: enable TCP segmentation offload


key: ufo

description: enable UDP fragmentation offload


key: gso

description: enable generic segmentation offload


key: gro

description: enable generic receive offload


key: lro

description: enable large receive offload


key: rxvlan

description: enable RX VLAN acceleration


key: txvlan

description: enable TX VLAN acceleration


key: ntuple

description: enable Rx ntuple filters and actions


key: rxhash

description: enable receive hashing offload


key: change

description: device settings


key: speed

description: speed in Mbps


key: duplex

description: full or half duplex mode


key: port

description: device port selection


key: mdix

description: MDI-X mode for port


key: autoneg

description: enable autonegotation


key: advertise

description: speed and duplex advertised by autonegotation


key: phyad

description: PHY address


key: xcvr

description: transceiver type


key: wol

description: Wake-on-LAN options


key: sopass

description: SecureOn™ password


key: msglvl

description: driver message flags


description: driver message flags by number


description: driver message flags by name


key: items

description: flag name


description: enable flag


key: channels

description: number of channels


key: rx

description: number of channels with only receive queues


key: tx

description: number of channels with only transmit queues


key: other

description: number of channels used only for other purposes


key: combined

description: number of multi-purpose channels


key: eee

description: Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)


description: enable EEE support


key: tx-lpi

description: assert Tx LPI


description: sets the speed for which EEE should be enabled (see also `change.advertise`)


key: tx-timer

description: amount of idle time prior asserting Tx LPI (in microseconds)


key: phy-tunable

description: PHY tunable parameters


key: downshift

description: enable downshift


description: enable downshift


description: enable downshift


description: *REQUIRED*


description: PHY downshift re-tries count


key: fast-link-down

description: enable Fast Link Down


description: enable Fast Link Down


description: enable Fast Link Down


description: period after which the link is reported as down


key: energy-detect-power-down

description: enable Energy Detect Power Down (EDPD)


description: enable EDPD


description: enable EDPD


description: wake-up interval for Tx pulses


key: priv-flags

description: private flags


key: fec

description: Forward Error Correction


key: encoding

description: FEC encoding


key: cshaper

description: simple shaper setup based on the [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) queue discipline; replaces any tc settings

default: unlimited

default: default


key: ingress

description: target ingress bandwidth


key: egress

description: target egress bandwidth


key: profile

description: cshaper profile


key: tc

description: settings for traffic control

enum: basic flow fw matchall

required: kind mode key

enum: src dst proto proto-src proto-dst iif priority mark nfct nfct-src nfct-dst nfct-proto-src nfct-proto-dst rt-classid sk-uid sk-gid vlan-tag rxhash

required: kind mode keys

required: kind handle


description: enable the ingress qdisc for policing and shaping in ingress


key: qdisc

description: root queueing disciplines


key: filter

description: filter used by qdiscs


key: kind

description: filter type


key: items

description: [basic](https://man7.org/linux/man-pages/man8/tc-basic.8.html) - basic traffic control filter


key: match

description: match packets using the [extended match infrastructure](https://man7.org/linux/man-pages/man8/tc-ematch.8.html)


description: [flow](https://man7.org/linux/man-pages/man8/tc-flow.8.html) - flow based traffic control filter


key: baseclass

description: offset for the class ID calculation


key: mode

description: filter mode


key: key

description: map to class ID by key


key: keys

description: hash over keys for class ID calculation


key: perturb

description: rehashing interval (in seconds)


description: [fw](https://man7.org/linux/man-pages/man8/tc-fw.8.html) - fwmark traffic control filter


key: handle

description: fwmark (iptables) to match


description: [matchall](https://man7.org/linux/man-pages/man8/tc-matchall.8.html) - traffic control filter that matches every packet


key: classid

description: push matching packets into class


key: flags

description: process flags (1: SKIP_HW, 2: SKIP_SW)


key: wireguard

description: settings for WireGuard interfaces


description: local private key (consider to use the `!include` tag to read the key from file)


description: port for listening


key: fwmark

description: fwmark for outgoing packets


key: peers

description: list of peer definitions


description: the peer's public key


description: preshared key for post-quantum resistance (consider to use the `!include` tag to read the key from file)


key: endpoint

description: initial endpoint IP or hostname


description: keepalive interval seconds


key: allowedips

description: list of prefixes in CIDR notation


key: xdp

description: settings for XDP ("eXpress Data Path") BPF program

format: ^/sys/fs/bfd/.


description: remove attached XDP program


description: attach already pinned XDP program


key: pinned

description: path to already pinned XDP program


description: BPF program from ifstate's bpf config section


key: bpf

description: BPF program (key in bpf config section)


key: type

description: the type of this route

enum: unicast local broadcast anycast multicast blackhole unreachable prohibit throw nat xresolve

default: unicast


key: dev

description: the output device name


key: proto

description: the routing protool identifier of this route


key: realm

description: the realm to which this route is assigned


key: scope

description: the scope of the destinations covered by the route prefix


key: table

description: the table to add this route to


key: to

description: the destination prefix of the route


key: via

description: address of the nexthop router


key: src

description: the source address to prefer


key: preference

description: preference of the route


key: action

description: the type of this rule

enum: to_tbl blackhole unreachable prohibit


key: priority

description: the priority of this rule


key: from

description: select the source prefix to match


description: select the destination prefix to match


key: iif

description: select the incoming device to match


key: oif

description: select the outgoing device to match


description: routing protocol number (`/etc/iproute2/rt_protos`)


key: fwmark

description: select the *fwmark* value to match


key: ipproto

description: select the ip protocol to match


description: ID of the project


description: File format name. See the format guide in the documentation for all supported file formats.

default: yml


description: Locale that should be downloaded. Locale ID or locale name are valid options


key: encoding

description: Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1"


key: phraseapp

description: Root element of the PhraseApp config

default: desc


key: defaults

description: Default configuration for API endpoints


key: host

description: API host URL. Only needs to be changed for OnPremise usage


description: Access Token for authorization. Can be created in the user profile


key: sources

description: Source files that will be uploaded on push


key: file

description: Translation file which will be uploaded


key: params

description: Locale upload parameter


key: branch

description: Branch name


key: tags

description: List of tags separated by comma to be associated with the new keys contained in the upload


description: Indicates whether existing translations should be updated with the file content


description: Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions


description: Indicates whether the file contains Emoji symbols that should be converted


description: Indicates whether the upload should not create upload tags


description: Indicates whether the upload should unverify updated translations


description: Additional options available for specific formats. See our format guide for complete list


description: Colum separator character


key: targets

description: List of files that will be downloaded on pull


description: Translation file which will be downloaded


description: Locale download parameter


key: tag

description: Limit result to keys tagged with the given tag (identified by its name)


description: Indicates whether keys without translations should be included in the output as well


description: Indicates whether [NOTRANSLATE] tags should be kept


description: Indicates whether Emoji symbols should be converted to actual Emojis


description: Indicates whether the locale file should skip all unverified translations


description: If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true


description: The artifacts configuration

required: commands events eventSources readModels queries

required: generation type


key: artifactsByTypeDefinition

description: The artifacts by type definition


key: commands

description: The command artifacts of a Feature


key: events

description: The event artifacts of a Feature


key: eventSources

description: The event source artifacts of a Feature


key: readModels

description: The read model artifacts of a Feature


key: queries

description: The query artifacts of a Feature


key: artifactDefinition

description: The definition of an artifact


key: generation

description: The artifact generation


key: type

description: The CLR Type represented by the artifact


description: Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html

enum: plan-failed plan-completed plan-status-changed plan-comment-added plan-responsibility-changed job-completed job-status-changed job-failed job-error job-first-failed job-hung job-queue-timeout job-queued-without-capable-agents

enum: view edit build admin clone deploy

enum: inject-variables clean checkout artifact-download


key: deployment

description: A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed


key: docker

description: Builds and deployments are normally run on the Bamboo agent's native operating system


key: job

description: A job is a single build unit within a plan and is made up of one or more tasks.


key: artifact

description: Artifacts are files created by a job build (e.g. JAR files)


key: location

description: The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.


key: name

description: Name of the artifact; in case artifact is shared, name must be unique within the plan.


key: pattern

description: Name or Ant pattern of file(s) to keep.


key: shared

description: You can share an artifact among other jobs or plans.


key: task

description: A task is a small unit of work, such as source code checkout, or running a script


key: test-parser

description: The Test Results Parser task in Bamboo parses test data


key: keyValue

description: Variables can be used to make values available when building plans in Bamboo.


key: permission

description: Plan permissions allow a user to control access to the functions of the build plan.


description: Plan permissions allow a user to control access to the functions of the build plan


key: plan

description: A plan defines everything about your continuous integration build process in Bamboo.


key: stage

description: Stages group jobs to individual steps within a plan's build process.


key: manual

description: Will await for execution by user


key: final

description: Will be executed regardless of other stages state (pass or fail)


description: A task is a small unit of work, such as source code checkout, or running a script.


key: cron

description: Execute deployment by schedule.


key: default-environment-permissions

description: These permissions apply to all environments defined in this deployment project


key: deployment-permissions

description: These permissions apply to the deployment project


key: environment-permissions

description: Permissions specific to an environment


key: environments

description: An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly


key: release-naming

description: You can define how releases should be named when they are created by Bamboo


key: stages


description: Make agile applications without technical debt

required: name type

enum: bigint.unsigned bigint blob.long blob.medium blob.tiny blob boolean char date decimal enum float id int.unsigned int json manyToMany password relationship smallint.unsigned smallint text timestamp tinyint.unsigned tinyint varchar

enum: index unique

type: number string boolean

required: path resolverType httpMethod

enum: query mutation

enum: get post put delete patch

enum: many-to-many many-to-one none one-to-many one-to-one

required: boundedContextName moduleName moduleNames aggregateName


key: name

description: The name of property, in camelCase


key: type

description: The type of property


key: length

description: Set max length to property


key: maxLength

description: Set max length to property


key: nullable

description: Set property to nullable


key: primaryKey

description: Set property to primary key


key: index

description: To define property like a index


key: indexName

description: The name of index, if there are various indexes with the same name, they will be grouped


key: enumOptions

description: Values for enum type


key: defaultValue

description: Default value for property


key: example

description: Example value for property, this value will be used in swagger documentation


key: decimals

description: Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].


key: autoIncrement

description: Set number property as auto increment


key: path

description: Path to access api


key: resolverType

description: Type of resolver, query or mutation


key: httpMethod

description: Verb of api rest


key: relationship

description: Relationship definition for this property


description: The type of web component


key: singularName

description: Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book


key: aggregate

description: Aggregate referring to this relationship, example: LibraryAuthor


key: modulePath

description: Path to the module that refers to this relationship, example: library/author


key: key

description: Property key that refers to this relationship, only for many-to-one relationship, example: id


key: field

description: Field to obtain the relationship data, example: author


key: avoidConstraint

description: Avoid constraint rules for this relationship


key: packageName

description: Path to packageName where is the relationship, example: @aurora-ts/core


key: isDenormalized

description: Set many-to-many relationship as denormalized, creating a field to store the selected ids


key: webComponent

description: Web Component that wil be rendered for this property


key: type

description: The type of web component


key: pivotTable

description: Relationship pivot table definition for this relationship


description: AggregateName of Pivot table, example: IamRolesAccounts


description: Module path where table model file will be saved, example: iam/role


key: fileName

description: Filename of pivot table model file, example: roles-accounts


key: version

description: Schema version


key: boundedContextName

description: The name of the bounded context, singular in kebab-case


key: moduleName

description: The name of the module, singular in kebab-case


key: moduleNames

description: The name of the module, plural in kebab-case


key: aggregateName

description: The name of the aggregateName, singular in PascalCase


key: hasOAuth

description: Enabled authentication for this module


key: hasTenant

description: Enabled tenant for this module


key: hasAuditing

description: Enabled auditing for this module


description: Serverless Workflow specification - workflow schema

format: uri

default: jq

required: id specVersion states

required: key specVersion states

required: before after

type: string object

required: errorRef transition

required: errorRef end

required: errorRefs transition

required: errorRefs end

enum: sequential parallel

default: sequential

enum: sync async

default: sync

enum: continue terminate

default: terminate

required: name actions

const: sleep

required: name type duration end

required: name type duration transition

required: name type eventConditions defaultCondition

required: name type dataConditions defaultCondition

required: name type inputCollection actions transition


key: id

description: Workflow unique identifier


key: key

description: Domain-specific workflow identifier


key: name

description: Workflow name


key: description

description: Workflow description


description: Workflow version


key: annotations

description: List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities


key: constants

description: URI to a resource containing constants data (json or yaml)


description: Workflow constants data (object type)


key: specVersion

description: Serverless Workflow schema version


key: expressionLang

description: Identifies the expression language used for workflow expressions. Default is 'jq'


key: keepActive

description: If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'


key: autoRetries

description: If set to true, actions should automatically be retried on unchecked errors. Default is false


key: states

description: State definitions


key: before

description: Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined.


key: after

description: Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined.


key: crondef

description: Cron expression defining when workflow instances should be created (automatically)


key: expression

description: Repeating interval (cron expression) describing when the workflow instance should be created


key: validUntil

description: Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid


key: continueasdef

description: Unique id of the workflow to be continue execution as. Entire state data is passed as data input to next execution


key: workflowId

description: Unique id of the workflow to continue execution as


key: version

description: Version of the workflow to continue execution as


key: data

description: If string type, an expression which selects parts of the states data output to become the workflow data input of continued execution. If object type, a custom object to become the workflow data input of the continued execution


key: workflowExecTimeout

description: Workflow execution timeout to be used by the workflow continuing execution. Overwrites any specific settings set by that workflow


key: transition

description: Name of state to transition to


description: Function Reference


key: nextState

description: Name of state to transition to


key: produceEvents

description: Array of events to be produced before the transition happens


key: compensate

description: If set to true, triggers workflow compensation when before this transition is taken. Default is false


key: errorRef

description: Reference to a unique workflow error definition. Used of errorRefs is not used


key: errorRefs

description: References one or more workflow error definitions. Used if errorRef is not used


description: Transition to next state to handle the error.


key: end

description: End workflow execution in case of this error.


key: eventRefs

description: References one or more unique event names in the defined workflow events


key: actionMode

description: Specifies how actions are to be performed (in sequence or in parallel)


key: actions

description: Actions to be performed if expression matches


key: eventDataFilter

description: Event data filter


key: name

description: Unique action definition name


key: functionRef

description: References a function to be invoked


key: eventRef

description: References a `produce` and `consume` reusable event definitions


key: subFlowRef

description: References a sub-workflow to invoke


key: sleep

description: Defines time periods workflow execution should sleep before / after function execution


key: retryRef

description: References a defined workflow retry definition. If not defined the default retry policy is assumed


key: nonRetryableErrors

description: List of unique references to defined workflow errors for which the action should not be retried. Used only when `autoRetries` is set to `true`


key: retryableErrors

description: List of unique references to defined workflow errors for which the action should be retried. Used only when `autoRetries` is set to `false`


key: actionDataFilter

description: Action data filter


key: condition

description: Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded


key: functionref

description: Name of the referenced function


description: Function Reference


key: refName

description: Name of the referenced function


key: arguments

description: Function arguments/inputs


key: selectionSet

description: Only used if function type is 'graphql'. A string containing a valid GraphQL selection set


key: invoke

description: Specifies if the function should be invoked sync or async


key: eventref

description: Event References


key: produceEventRef

description: Reference to the unique name of a 'produced' event definition


key: consumeEventRef

description: Reference to the unique name of a 'consumed' event definition


key: consumeEventTimeout

description: Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout


key: data

description: If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'produceEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'produceEventRef'.


key: contextAttributes

description: Add additional extension context attributes to the produced event


key: subflowref

description: Unique id of the sub-workflow to be invoked


description: Specifies a sub-workflow to be invoked


key: workflowId


key: version

description: Version of the sub-workflow to be invoked


key: onParentComplete

description: If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'


description: Specifies if the subflow should be invoked sync or async


key: branch

description: Branch Definition


key: name

description: Branch name


key: timeouts

description: State specific timeouts


key: actions

description: Actions to be executed in this branch


key: sleepstate

description: Causes the workflow execution to sleep for a specified duration


description: State name


key: type

description: State type


key: end

description: State end definition


key: duration

description: Duration (ISO 8601 duration format) to sleep


key: transition

description: Next transition of the workflow after the workflow sleep


key: eventstate

description: This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel

const: event

required: name type onEvents end

required: name type onEvents transition


description: State type


key: exclusive

description: If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed


key: onEvents

description: Define the events to be consumed and optional actions to be performed


key: stateDataFilter

description: State data filter


key: onErrors

description: States error handling definitions


description: Next transition of the workflow after all the actions have been performed


key: compensatedBy

description: Unique Name of a workflow state which is responsible for compensation of this state


key: operationstate

description: Defines actions be performed. Does not wait for incoming events

const: operation

required: name type actions

required: name type actions end

required: name type actions transition


description: State type


key: actionMode

description: Specifies whether actions are performed in sequence or in parallel


description: Actions to be performed


description: State specific timeouts


key: usedForCompensation

description: If true, this state is used to compensate another state. Default is false


key: parallelstate

description: Consists of a number of states that are executed in parallel

const: parallel

enum: allOf atLeast

default: allOf

type: number string

required: name type branches

required: name type branches end

required: name type branches transition


key: name

description: State name


description: State type


description: State end definition


key: branches

description: Branch Definitions


key: completionType

description: Option types on how to complete branch execution.


key: numCompleted

description: Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition.


description: Next transition of the workflow after all branches have completed execution


key: eventbasedswitchstate

description: Permits transitions to other states based on events

const: switch


key: type

description: State type


description: State data filter


key: eventConditions

description: Defines conditions evaluated against events


description: States error handling definitions


key: defaultCondition

description: Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition


key: databasedswitchstate

description: Permits transitions to other states based on data conditions


key: timeouts

description: State specific timeouts


key: dataConditions

description: Defines conditions evaluated against state data


key: defaultconditiondef

description: DefaultCondition definition. Can be either a transition or end definition


description: The optional name of the default condition, used solely for display purposes


key: transitioneventcondition

description: Switch state data event condition

required: eventRef transition


description: Event condition name


key: eventRef

description: References an unique event name in the defined workflow events


key: transition

description: Next transition of the workflow if there is valid matches


key: eventDataFilter

description: Event data filter definition


key: endeventcondition

description: Switch state data event condition

required: eventRef end


key: end

description: Explicit transition to end


key: transitiondatacondition

description: Switch state data based condition

required: condition transition


key: name

description: Data condition name


key: condition

description: Workflow expression evaluated against state data. Must evaluate to true or false


description: Workflow transition if condition is evaluated to true


key: enddatacondition

description: Switch state data based condition

required: condition end


description: Workflow end definition


key: injectstate

description: Inject static data into state data. Does not perform any actions

const: inject

required: name type data

required: name type data end

required: name type data transition


description: State name


key: type

description: State type


description: State end definition


key: data

description: JSON object which can be set as states data input and can be manipulated via filters


key: stateDataFilter

description: State data filter


description: Next transition of the workflow after injection has completed


key: compensatedBy

description: Unique Name of a workflow state which is responsible for compensation of this state


key: usedForCompensation

description: If true, this state is used to compensate another state. Default is false


key: foreachstate

description: Execute a set of defined actions or workflows for each element of a data array

const: foreach

default: parallel

required: name type inputCollection actions

required: name type inputCollection actions end


description: State type


key: inputCollection

description: Workflow expression selecting an array element of the states data


key: outputCollection

description: Workflow expression specifying an array element of the states data to add the results of each iteration


key: iterationParam

description: Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array


key: batchSize

description: Specifies how many iterations may run in parallel at the same time. Used if 'mode' property is set to 'parallel' (default)


key: actions

description: Actions to be executed for each of the elements of inputCollection


key: timeouts

description: State specific timeouts


key: onErrors

description: States error handling definitions


key: transition

description: Next transition of the workflow after state has completed


key: mode

description: Specifies how iterations are to be performed (sequentially or in parallel)


key: callbackstate

description: This state performs an action, then waits for the callback event that denotes completion of the action

const: callback

required: name type action eventRef

required: name type action eventRef end

required: name type action eventRef transition


key: name

description: State name


key: type

description: State type


key: action

description: Defines the action to be executed


key: eventRef

description: References an unique callback event name in the defined workflow events


key: eventDataFilter

description: Event data filter


key: stateDataFilter

description: State data filter


description: Next transition of the workflow after all the actions have been performed


key: end

description: State end definition


key: compensatedBy


key: usedForCompensation


key: startdef

description: Name of the starting workflow state


description: Workflow start definition


key: stateName

description: Name of the starting workflow state


key: schedule

description: Define the time/repeating intervals or cron at which workflow instances should be automatically started.


description: Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.  (UTC timezone is assumed)


description: Start state schedule definition


key: interval

description: Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.


key: timezone

description: Timezone name used to evaluate the interval & cron-expression. (default: UTC)


description: State end definition


description: State end definition


key: terminate

description: If true, completes all execution flows in the given workflow instance


key: produceEvents

description: Defines events that should be produced


key: compensate

description: If set to true, triggers workflow compensation. Default is false


key: produceeventdef

description: Produce an event and set its data


description: References a name of a defined event


key: data

description: If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event.


key: contextAttributes

description: Add additional event extension context attributes


key: input

description: Workflow expression to filter the state data input


key: output

description: Workflow expression that filters the state data output


key: useData

description: If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true.


description: Workflow expression that filters the received event payload (default: '${ . }')


key: toStateData

description: Workflow expression that selects a state data element to which the filtered event should be added/merged into. If not specified, denotes, the top-level state data element.


key: fromStateData

description: Workflow expression that selects state data that the state action can use


key: useResults

description: If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true.


key: results

description: Workflow expression that filters the actions data results


description: Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element


key: validationSchema

description: URI of the JSON Schema used to validate the workflow


description: Workflow data input schema definition


key: oneof


description: The JSON Schema object used to validate the workflow


key: failOnValidationErrors

description: Determines if error should be thrown if there are validation errors


key: variant

description: Used to differentiate configs for different operating systems. Must be fcos for this specification.

default: fcos


key: type

description: The type of the field.


key: default

description: Default value of the field.


key: name

description:
Where the dependency is located in `deps/`.

See more: https://github.com/bpkg/bpkg#name


key: version

description:
The current version of the dependency.

See more: https://github.com/bpkg/bpkg#version-optional


key: description

description:
Human-readable description of the functionality of the package.

See more: https://github.com/bpkg/bpkg#description


key: global

description:
Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing.

See more: https://github.com/bpkg/bpkg#global


key: install

description:
Shell script used to invoke in the install script. Required if package is being installed as a global script.

See more: https://github.com/bpkg/bpkg#install-1

default: make install


key: scripts

description: An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts


key: files

description: An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional


key: dependencies

description:
Hash of dependencies of this project. Use either a tagged release identifier or `master`.

See more: https://github.com/bpkg/bpkg#dependencies-optional


key: dependencies-dev

description:
Hash of development dependencies of this project. Use either a tagged release identifier or `master`.

See more: https://github.com/bpkg/bpkg#dependencies-dev-optional


key: commands

description:
A hash of runnable commands for `bpkg run`.

See more: https://github.com/bpkg/bpkg#commands-optional


key: commands-description

description:
A hash of descriptions for each command in `commands`.

See more: https://github.com/bpkg/bpkg#commands-description-optional


description:
Strings of the current application
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Usage:

default: Options:

default: Arguments:

default: Commands:

default: Examples:

default: Environment Variables:

default: %{group} Commands:

default: Alias: %{alias}

default: %{summary} (default)

default: (required)

default: (repeatable)

default: Default: %{value}

default: Allowed: %{values}

default: Show this help

default: Show version number

default: %{name} requires an argument: %{usage}

default: invalid argument: %s

default: invalid option: %s

default: invalid command: %s

default: conflicting options: %s cannot be used with %s

default: missing required argument: %{arg}\nusage: %{usage}

default: missing required flag: %{usage}

default: missing required environment variable: %{var}

default: missing dependency: %{dependency}

default: %{name} must be one of: %{allowed}

default: bash version 4 or higher is required

default: validation error in %s:\n%s


key: usage

description:
A usage caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Usage:


key: options

description:
An option caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Options:


key: arguments

description:
An argument caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Arguments:


description:
A command caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Commands:


key: examples

description:
An example caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Examples:


description:
An environment variable caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Environment Variables:


key: group

description:
A group caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{group} Commands:


description:
An alias helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Alias: %{alias}


description:
A default command summary helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{summary} (default)


key: required

description:
A required helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: (required)


key: repeatable

description:
A repeatable helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: (repeatable)


key: default

description:
A default helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Default: %{value}


key: allowed

description:
An allowed helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Allowed: %{values}


description:
A help flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Show this help


description:
A version flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Show version number


description:
A missing flag argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{name} requires an argument: %{usage}


description:
An invalid argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid argument: %s


description:
An invalid option error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid option: %s


description:
An invalid command error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid command: %s


description:
A conflicting options error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: conflicting options: %s cannot be used with %s


description:
A missing required argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required argument: %{arg}\nusage: %{usage}


description:
A missing required flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required flag: %{usage}


description:
A missing required environment variable error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required environment variable: %{var}


description:
A missing dependency error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing dependency: %{dependency}


description:
A forbidden flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{name} must be one of: %{allowed}


description:
A forbidden argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings


description:
An unsupported Bash version error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: bash version 4 or higher is required


description:
A validation error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: validation error in %s:\n%s


key: apiLocation

description: API folder or Azure Functions emulator address


key: apiPort

description: API backend port


key: appArtifactLocation

description: Location of the build output directory relative to the appLocation


key: appLocation

description: Location for the static app source code


key: devserverTimeout

description: Time to wait(in ms) for the dev server to start


key: host

description: CLI host address


key: port

description: set the cli port


key: run

description: Run a command at startup


key: ssl

description: Serve the app and API over HTTPS


key: sslCert

description: SSL certificate (.crt) to use for serving HTTPS


key: sslKey

description: SSL key (.key) to use for serving HTTPS


key: path

description: Relative path to resource.


key: regex

description: A regular expression for identifying paths to resources.


key: allowData

description: Determines if data is allowed at this path.


key: site

description: A fully qualified URL of your website.


key: maxAge

description: Set the max age HTTP cache expiration.


description: The tenants configuration


key: additionalProperties

description: The configuration of a tenant


key: CompilerOptions

description: A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details

default: tsc

enum: tsc webpack swc


key: tsConfigPath

description: (monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.


key: builder

description: Builder to be used (tsc, webpack, swc). For details on how to configure `SWC` see https://docs.nestjs.com/recipes/swc#getting-started


key: typeCheck

description: If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.


key: webpack

description: If true, use webpack compiler (deprecated option, use `builder` instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.


key: webpackConfigPath

description: Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.


key: assets

description: Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.


key: watchAssets

description: If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.


key: deleteOutDir

description: If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist).


key: manualRestart

description: If true, enables the shortcut `rs` to manually restart the server.


key: AssetsOptions

description: For finer control, the element can be object.


key: include

description: Glob-like file specifications for the assets to be distributed.


key: exclude

description: Glob-like file specifications for the assets to be excluded from the include list.


key: outDir

description: A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output.


description: If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.


key: GenerateOptions

description: A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details


key: GenerateFlatOptions

description: If true, all generate commands will generate a flat structure


key: GenerateSpecOptions

description: If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

type: boolean object


key: application

description: Generate spec file for application schematics or not.


key: class

description: Disable spec file generation for class schematics.


key: cl

description: Alias for class


key: configuration

description: Generate spec file for configuration schematics or not.


key: config

description: Alias for configuration


key: controller

description: Generate spec file for controller schematics or not.


key: co

description: Alias for controller


key: decorator

description: Generate spec file for decorator schematics or not.


key: d

description: Alias fro decorator


key: filter

description: Generate spec file for filter schematics or not.


key: f

description: Alias for filter


key: gateway

description: Generate spec file for gateway schematics or not.


key: ga

description: Alias for gateway


key: guard

description: Generate spec file for guard schematics or not.


key: gu

description: Alias for guard


key: interceptor

description: Generate spec file for interceptor schematics or not.


key: in

description: Alias for interceptor


key: interface

description: Generate spec file for interface schematics or not.


key: middleware

description: Generate spec file for middleware schematics or not.


key: mi

description: Alias for middleware


key: module

description: Generate spec file for module schematics or not.


key: mo

description: Alias for module


key: pipe

description: Generate spec file for pipe schematics or not.


key: pi

description: Alias for pipe


key: provider

description: Generate spec file for provider schematics or not.


key: pr

description: Alias for provider


key: resolver

description: Generate spec file for resolver schematics or not.


key: r

description: Alias for resolver


key: service

description: Generate spec file for service schematics or not.


key: s

description: Alias for resolver


key: library

description: Generate spec file for library schematics or not.


key: lib

description: Alias for library


key: sub-app

description: Generate spec file for sub-app schematics or not.


key: app

description: Alias for sub-app


key: resource

description: Generate spec file for resource schematics or not.


key: res

description: Alias for resource


key: GenerateBaseDirOptions

description: Base directory


key: name

description: The npm package name of the cli plugin, eg @nestjs/swagger.


key: introspectComments

description: If set to true, plugin will generate descriptions and example values for properties based on comments.


key: typeFileNameSuffix

description: (GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details.


key: dtoFileNameSuffix

description: (Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details


key: controllerFileNameSuffix

description: (Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details


key: classValidatorShim

description: (Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details


key: dtoKeyOfComment

description: (Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

default: description


key: controllerKeyOfComment

description: (Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details


key: collection

description: Points at the collection of schematics used to generate components. you generally should not change this value.


key: sourceRoot

description: Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures.

default: src


key: entryFile

description: The entry file where 'nest start' work with. Default to 'main'.

default: main


key: monorepo

description: (monorepo only) For a monorepo mode structure, this value is always true.


key: root

description: (monorepo only) Points at the project root of the default project.


key: branch

description:
When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.
The branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
The patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.
You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:
- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.
- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.
You can exclude tags and branches using the ! character. The order that you define patterns matters.
- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.
- A matching positive pattern after a negative match will include the Git ref again.


key: group

description: When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.


key: cancel-in-progress

description: To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.


key: image

description: The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.


key: credentials

description: If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.


key: env

description: Sets an array of environment variables in the container.


key: ports

description: Sets an array of ports to expose on the container.


key: volumes

description:
Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.
To specify a volume, you specify the source and destination path: <source>:<destinationPath>
The <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.


key: options

description: Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.


key: permissions

description: You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.

enum: read-all write-all


description: To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv


key: environment

description: The environment that the job references


key: name

description: The name of the environment configured in the repo.


key: url

description: A deployment URL


key: path

description:
When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.
The paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.
- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.
- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.


key: shell

description: You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.

enum: bash pwsh python sh cmd powershell


key: types

description:
Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.


key: working-directory

description: Using the working-directory keyword, you can specify the working directory of where to run the command.


key: jobNeeds

description: Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.


key: reusableWorkflowCallJob

description: Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.

type: boolean number string


description: The name of the job displayed on GitHub.

type: string


key: if

description:
You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.
Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.


key: uses

description: The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.


key: with

description: A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.<job_id>.steps[*].with', the inputs you pass with 'jobs.<job_id>.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context.


key: secrets

description: When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow.


key: strategy

description: A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.

type: object


key: matrix

description:
A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.
You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.
When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

type: array


key: fail-fast

description: When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true

type: boolean


key: max-parallel

description: The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.


key: concurrency

description:
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context.
You can also specify concurrency at the workflow level.
When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.


key: normalJob

const: self-hosted

const: linux

const: windows


key: runs-on

description: The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.


key: environment

description: The environment that the job references.


key: outputs

description: A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.


key: env

description: A map of environment variables that are available to all steps in the job.


key: defaults

description: A map of default settings that will apply to all steps in the job.


key: steps

description:
A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.
Must contain either `uses` or `run`


key: id

description: A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.


key: if

description:
You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.
Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.


key: name

description: A name for your step to display on GitHub.


key: uses

description:
Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/).
We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
- Using the commit SHA of a released action version is the safest for stability and security.
- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.
- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.
Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions.


key: run

description:
Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.
Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.
Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.


key: with

description: A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.


description: Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job.


key: continue-on-error

description: Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.


key: timeout-minutes

description: The maximum number of minutes to run the step before killing the process.


description: The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360


key: strategy

description: A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.


key: matrix

description:
A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.
You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.
When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.


key: fail-fast

description: When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true


key: max-parallel

description: The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.


description: Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.


key: container

description:
A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.
If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.


key: services

description:
Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.
When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.
When both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.
When a step does not use a container action, you must access the service using localhost and bind the ports.


key: concurrency

description:
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context.
You can also specify concurrency at the workflow level.
When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.


description: The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.