organizationConfig

Class OrganizationConfig

Source
Expand description

Represents the configuration for the Logus organization.

This class defines default configuration values. When loading from a repository:

  • If no custom configuration is found, all default values are used.
  • If custom configuration exists, its values override the defaults.
  • Any fields not specified in the custom configuration fall back to their default values.

Constructors§

Source§

new OrganizationConfig(
    keywordConfig?: OrganizationConfig | undefined,
): OrganizationConfig

Creates an instance of OrganizationConfig.

Properties§

§readonly addPullRequestAuthorAsAssignee: booleantrue

Indicates whether the pull request author should be added as an assignee.

default
true
§readonly firstReviewSubmitDateProjectFieldName?: string"First Review Date"

The name of the field for the first review submit date.

default
"First Review Date"
§readonly lastApprovedReviewSubmitDateProjectFieldName?: string"Last Approved Review Date"

The name of the field for the last approved review submit date.

default
"Last Approved Review Date"
§readonly lastReviewSubmitDateProjectFieldName?: string"Last Review Date"

The name of the field for the last review submit date.

default
"Last Review Date"
§readonly openPullRequestDateProjectFieldName?: string"Posted Date"

The name of the field for the open pull request date.

default
"Posted Date"
§readonly projectTemplateNumber?: number

The number of the project template.

§readonly projectTitlePrefix: string"monitor-"

The prefix for project titles.

default
"monitor-"
§readonly reviewIterationNumberProjectFieldName?: string"Review Iteration"

The name of the field for the review iteration number.

default
"Review Iteration"
§private static readonly configFileName: string"logus.yml"

The name of the configuration file.

Methods§

Source§

load(context: LogusOrgConfigContext): Promise<OrganizationConfig>

Loads the organization configuration from the repository.

Attempts to load configuration from .github-private/.github/logus.yml. If the file is not found, falls back to .github/.github/logus.yml. If no configuration file exists, returns the default configuration values defined in this class.

When a custom configuration is found, values from the custom configuration override the default values. Any configuration fields not present in the custom configuration retain their default values.