Release
| Name | release |
| Enabled by default | No |
| Steps | 5 |
| Runs at once | up to 1 |
| Catalog | v0.29.0 |
What it does
What happens when a Release is cut. The Release has already committed the version to the repo's version files and tagged that commit; the version-manager checks the version files at the tag and writes the changelog and release order, the docs-writer publishes the release docs, and the blogger, newsletter and socializer draft the announcements and send the drafts to the org's Slack channel. Nothing is published anywhere: people read the drafts in Slack and post what they want by hand. A step whose AgentRole is disabled is Skipped. The workflow ships disabled: every run spends model tokens, so an org enables it when it wants announcement drafts for each Release.
When it runs
- On the event
release.cut. Runs when a Release is cut for a Product.
Steps
Rounded steps are human gates, slanted steps are promotions, and double-edged steps run automatically.
| # | Step | Type | Runs | Required | On failure | Attempts |
|---|---|---|---|---|---|---|
| 1 | versioning | AgentRole | Version manager | Yes | Dead-letter to a human | 1 |
| 2 | release-docs | AgentRole | Docs writer | No | Dead-letter to a human | 1 |
| 3 | blog-draft | AgentRole | blogger | No | Continue | 1 |
| 4 | newsletter-draft | AgentRole | newsletter | No | Continue | 1 |
| 5 | social-drafts | AgentRole | socializer | No | Continue | 1 |
1. versioning
Confirms the semver bump, writes the changelog and upgrade notes, and orders the releases of a Product's repos.
Skipped when its AgentRole is switched off.
2. release-docs
Publishes release notes and updates external product docs for the Release.
Skipped when its AgentRole is switched off.
3. blog-draft
Drafts the release blog post and sends it to the org's Slack channel.
Starts after release-docs. Skipped when its AgentRole is switched off.
4. newsletter-draft
Drafts the Release's newsletter item and sends it to the org's Slack channel.
Starts after release-docs. Skipped when its AgentRole is switched off.
5. social-drafts
Drafts a post for each of the org's announcement accounts (Settings → Announcements; pretend accounts are fine) and sends them to the org's Slack channel. Nothing is posted.
Starts after release-docs. Runs only when agentRole.enabled. Skipped when its AgentRole is switched off.
When it hands off to a human
Work an agent cannot finish is dead-lettered to @platform/release-managers. The AgentWorkflowRun shows the step as DeadLettered until a human picks it up.