Skip to main content
Version: 0.1 (next)

Release

Namerelease
Enabled by defaultYes
Steps7
Runs at onceup to 1
Catalogv0.2.0

What it does​

What happens when a Release is cut. The version-manager finalizes the version, changelog and umbrella sequencing, the docs-writer publishes the release docs, and the blogger, newsletter and socializer draft the announcements. Nothing reaches a social network or the marketing site until a human approves the drafts. A step whose AgentRole is disabled is Skipped, and the steps that need it continue without it.

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.

#StepTypeRunsRequiredOn failureAttempts
1versioningAgentRoleVersion managerYesDead-letter to a human1
2release-docsAgentRoleDocs writerNoDead-letter to a human1
3blog-draftAgentRoleBloggerNoContinue1
4newsletter-draftAgentRoleNewsletterNoContinue1
5social-draftsAgentRoleSocializerNoContinue1
6approve-announcementsHuman gateHuman gateYesFail the run1
7publishAutomaticAutomaticNoDead-letter to a human1

1. versioning​

Confirms the semver bump, writes the changelog and upgrade notes, and sequences micro and umbrella releases.

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 as a pull request to the marketing site.

Starts after release-docs. Skipped when its AgentRole is switched off.

4. newsletter-draft​

Adds the Release to the next newsletter draft.

Starts after release-docs. Skipped when its AgentRole is switched off.

5. social-drafts​

Drafts posts for LinkedIn, X, Bluesky and the marketing site. The socializer ships disabled, so this step is Skipped until the org enables it; approve-announcements then proceeds without social drafts.

Starts after release-docs. Runs only when agentRole.enabled. Skipped when its AgentRole is switched off.

6. approve-announcements​

A human reviews every draft and approves, edits or rejects each one before anything is published.

Starts after blog-draft, newsletter-draft, social-drafts.

7. publish​

Publishes the approved drafts only.

When it hands off to a human​

Human gates: approve-announcements. Required steps cannot be switched off for a Release.

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.