Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 4.57 KB

API.md

File metadata and controls

74 lines (44 loc) · 4.57 KB
Raw

API Reference

Classes

Name Description
ChangelogSlackNotify No description

Structs

Name Description
ChangelogSlackNotifyProps No description

class ChangelogSlackNotify

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ChangelogSlackNotify(scope: Construct, id: string, props: ChangelogSlackNotifyProps)
  • scope (Construct) No description
  • id (string) No description
  • props (ChangelogSlackNotifyProps) No description
    • channelName (string) Slack channel name for sending message.
    • repositoryName (string) repository name to track.
    • slackToken (string) Slack secret token for sending message.
    • breakingChangeTypeDisplayName (string) Display name in notification message for breaking changes. Default: If this value is not set, considers to BREAKING CHANGES
    • changelogPath (string) Path of changelog file in repository. Default: If this value is not set, considers to read commits push in master on this time to build notification message
    • featureTypeDisplayName (string) Display name in notification message for feature changes. Default: If this value is not set, considers to New Features
    • fixTypeDisplayName (string) Display name in notification message for fix changes. Default: If this value is not set, considers to Bugs Fixed
    • fromExistRepository (boolean) set True to use $repositoryName to find exist repository. Default: If this value is not set, considers to false
    • performanceTypeDisplayName (string) Display name in notification message for performance improvement changes. Default: If this value is not set, considers to Performance Improvement
    • trackingBranches (Array) Branches which were tracking to send notification message. Default: If this value is not set, considers to track master branch
    • undefinedTypeDisplayName (string) Display name in notification message for undefined type changes. Default: If this value is not set, considers to Others

struct ChangelogSlackNotifyProps

Name Type Description
channelName string Slack channel name for sending message.
repositoryName string repository name to track.
slackToken string Slack secret token for sending message.
breakingChangeTypeDisplayName? string Display name in notification message for breaking changes.
Default: If this value is not set, considers to BREAKING CHANGES
changelogPath? string Path of changelog file in repository.
Default: If this value is not set, considers to read commits push in master on this time to build notification message
featureTypeDisplayName? string Display name in notification message for feature changes.
Default: If this value is not set, considers to New Features
fixTypeDisplayName? string Display name in notification message for fix changes.
Default: If this value is not set, considers to Bugs Fixed
fromExistRepository? boolean set True to use $repositoryName to find exist repository.
Default: If this value is not set, considers to false
performanceTypeDisplayName? string Display name in notification message for performance improvement changes.
Default: If this value is not set, considers to Performance Improvement
trackingBranches? Array Branches which were tracking to send notification message.
Default: If this value is not set, considers to track master branch
undefinedTypeDisplayName? string Display name in notification message for undefined type changes.
Default: If this value is not set, considers to Others