relizy / SlackSocialConfig

Interface: SlackSocialConfig

Defined in: src/types.ts:713

Properties

channel?

optional channel?: string

Defined in: src/types.ts:730

Slack channel ID or name (e.g., "#releases" or "C1234567890"). Required when using token-based authentication. Ignored (with warning) when webhookUrl is set — the channel is baked into the webhook URL.

---

credentials?

optional credentials?: SlackCredentials

Defined in: src/types.ts:745

Slack credentials (optional - falls back to environment variables)

---

enabled?

optional enabled?: boolean

Defined in: src/types.ts:718

Enable Slack posting

Default

false

---

noAuthors?

optional noAuthors?: boolean

Defined in: src/types.ts:757

Hide the contributors block in Slack messages. If config.noAuthors is true globally, contributors are always hidden regardless of this setting.

Default

false

---

noPackages?

optional noPackages?: boolean

Defined in: src/types.ts:762

Hide the packages block (list of bumped packages with their before → after versions).

Default

false

---

onlyStable?

optional onlyStable?: boolean

Defined in: src/types.ts:724

Skip Slack posting for prerelease versions (alpha, beta, rc, etc.) Only stable versions will be posted to Slack

Default

true

---

postMaxLength?

optional postMaxLength?: number

Defined in: src/types.ts:751

Maximum length (in characters) of the changelog rendered inside the Slack message. Slack's per-section-block limit is 3000; default 2500 leaves margin for emoji/formatting.

Default

2500

---

template?

optional template?: string

Defined in: src/types.ts:741

Custom message template Available variables: , , , , ,

---

webhookUrl?

optional webhookUrl?: string

Defined in: src/types.ts:736

Slack Incoming Webhook URL. When set, takes priority over token-based auth. Env fallback: SLACK_WEBHOOK_URL, RELIZY_SLACK_WEBHOOK_URL. See: https://api.slack.com/messaging/webhooks