relizy / TeamsSocialConfig

Interface: TeamsSocialConfig

Defined in: src/types.ts:1331

The content of the announcement of a version. The texts accept the variables of the announcement (see SocialAnnouncementVariables).

Extends

• SocialAnnouncementContent

Properties

announcements?

optional announcements?: SocialAnnouncement[]

Defined in: src/types.ts:1378

The versions to announce and their content. Without it, every version is announced with the content of social.teams; with it, only the versions matching an entry.

---

badge?

optional badge?: string | false

Defined in: src/types.ts:1367

Text of the badge above the title; false removes it

Default

'New release' ('Prerelease' for a prerelease)

---

cards?

optional cards?: TeamsCardsMode

Defined in: src/types.ts:1354

One card per version, or one card for the release

Default

'version'

---

changelog?

optional changelog?: SocialChangelog

Defined in: src/types.ts:1362

The changelog in the card: full (the commit bodies included), summary (the commit titles, rewritten with ai.social.teams), or none (or false), the buttons linking to it. Cut between two changes to fit in the 28 KB of a card.

Default

'none'

---

changelogUrl?

optional changelogUrl?: string | false

Defined in: src/types.ts:1259

URL of the changelog link of the version; false removes the link

Inherited from

SocialAnnouncementContent.changelogUrl

---

enabled?

optional enabled?: boolean

Defined in: src/types.ts:1336

Enable the Teams cards

Default

false

---

exclude?

optional exclude?: SocialExclude

Defined in: src/types.ts:1382

Versions never announced, even when an announcement matches them

---

links?

optional links?: SocialLink[]

Defined in: src/types.ts:1263

Links added after the release notes and the changelog

Inherited from

SocialAnnouncementContent.links

---

locale?

optional locale?: string

Defined in: src/types.ts:1372

Locale of the date of the card (BCP 47, e.g. fr-FR)

Default

'en-US'

---

message?

optional message?: string

Defined in: src/types.ts:1255

Text under the title, in markdown (bold, italic, links, lists)

Inherited from

SocialAnnouncementContent.message

---

onlyStable?

optional onlyStable?: boolean

Defined in: src/types.ts:1341

Skip the prerelease versions (alpha, beta, rc, etc.)

Default

true

---

title?

optional title?: string

Defined in: src/types.ts:1251

Title of the version: of its Teams card (or section), of its Slack section (or header, when the message announces a single version)

Inherited from

SocialAnnouncementContent.title

---

webhookUrl?

optional webhookUrl?: string

Defined in: src/types.ts:1349

URL of the Teams workflow ("When a Teams webhook request is received" trigger). It holds a secret (sig): prefer the environment. Env fallback: RELIZY_TEAMS_WEBHOOK_URL, TEAMS_WEBHOOK_URL, or the URL in base64 in RELIZY_TEAMS_WEBHOOK_URL_B64, TEAMS_WEBHOOK_URL_B64 (a masked GitLab variable refuses the characters of the URL).