Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProjectsOperationRegistration<PARAMS>

Superclass for all registrations that can apply to one or more projects.

Type parameters

  • PARAMS

Hierarchy

Index

Properties

Properties

Optional autoSubmit

autoSubmit: boolean

Configure command to submit without confirmation

Optional chatty

chatty: boolean

Whether or not this project operation should send messages during processing.

Defaults to true.

Optional concurrency

concurrency: { maxConcurrent?: number; requiresJob?: boolean }

Configure the concurrency behavior of running project operations on many repos

Type declaration

  • Optional maxConcurrent?: number

    Maximum number of concurrent project operations would be executing

  • Optional requiresJob?: boolean

    Indicate if a Job scheduling is required; even for only one project operation

Optional description

description: string

Description of the command

Optional intent

intent: string | string[] | RegExp

Intent or list of intents. What you need to type to invoke the command, for example via the bot.

name

name: string

Name of the command

Optional parameterStyle

parameterStyle: ParameterStyle

Configure strategy on how to prompt for parameters in chat or web

Optional parameters

parameters: ParametersDefinition<PARAMS>

Define parameters used by this command.

Optional paramsMaker

paramsMaker: Maker<PARAMS>

Function to create a parameters object used by this command. Empty parameters will be returned by default.

Optional projectTest

projectTest: ProjectPredicate

Programmatically limit repositories to inspect, by a project predicate. This can look inside project.

Optional registerWhen

registerWhen: (sdmConfiguration: SoftwareDeliveryMachineConfiguration) => boolean

If provided, select when this command is registered. Enables conditional registration on SDM startup, based on configuration, environment variables etc. This method is invoked during SDM startup.

param
returns

Type declaration

Optional repoFilter

repoFilter: RepoFilter

Additionally, programmatically limit repositories to inspect, by id

Optional repoFinder

repoFinder: RepoFinder

Optional repoLoader

repoLoader: (p: PARAMS) => RepoLoader

Type declaration

    • (p: PARAMS): RepoLoader

    • Parameters

      • p: PARAMS

      Returns RepoLoader

Optional tags

tags: string | string[]

Tags associated with this command. Useful in searching.

Optional targets

targets: Maker<RepoTargets>

Allow customization of the repositories that an inspection targets.

Generated using TypeDoc