relizy / SlackOptions

Interface: SlackOptions

Defined in: src/types.ts:916

Properties

changelog

changelog: string

Defined in: src/types.ts:928

Changelog content

---

changelogUrl?

optional changelogUrl?: string

Defined in: src/types.ts:936

Full changelog URL (e.g., https://example.com/changelog)

---

channel?

optional channel?: string

Defined in: src/types.ts:940

Slack channel ID or name. Required when using token-based auth.

---

contributors?

optional contributors?: string[]

Defined in: src/types.ts:961

Contributor names (plain strings, no email/handle). Empty array or undefined → no contributors block.

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:970

Run without side effects

Default

false

---

packages?

optional packages?: SlackPackageEntry[]

Defined in: src/types.ts:965

Packages bumped in this release. Empty array or undefined → no packages block.

---

postMaxLength?

optional postMaxLength?: number

Defined in: src/types.ts:957

Maximum chars of the changelog rendered in the message.

Default

2500

---

projectName

projectName: string

Defined in: src/types.ts:924

Project name

---

releaseUrl?

optional releaseUrl?: string

Defined in: src/types.ts:932

Release URL (GitHub/GitLab)

---

template?

optional template?: string

Defined in: src/types.ts:952

Custom message template

---

token?

optional token?: string

Defined in: src/types.ts:944

Slack Bot Token. Ignored if webhookUrl is set.

---

version

version: string

Defined in: src/types.ts:920

Release information

---

webhookUrl?

optional webhookUrl?: string

Defined in: src/types.ts:948

Slack Incoming Webhook URL. Takes priority over token.