Skip to content

Document the release and publishing workflow #73

@coisa

Description

@coisa

Objective

Document the release and publishing workflow for Fast Forward DevTools.

Current Limitation

The package is published through Composer/Packagist and generates docs/wiki/reports, but maintainers do not have a single documented release flow explaining how code, tags, Packagist, GitHub Pages, wiki, and generated artifacts fit together.

Proposed Work

Add release/publishing documentation for maintainers.

Scope

  • Versioning expectations and branch/tag flow.
  • Pre-release verification commands.
  • Packagist publication expectations.
  • GitHub Pages reports publication.
  • Wiki publication behavior.
  • Changelog/release notes expectations.
  • Post-release validation steps.

Non-goals

  • Automating releases in this issue.
  • Changing package versioning policy.
  • Adding changelog features already tracked by separate issues.

Acceptance Criteria

Delivery Criteria

  • Release documentation exists under docs/internals, docs/advanced, or a maintainer-focused docs section.
  • The guide lists required checks before release.
  • The guide explains how docs, reports, and wiki publishing happen.
  • The guide includes post-release validation steps.
  • The guide links to Packagist/GitHub release surfaces where appropriate.

Architectural / Isolation Criteria

  • Documentation is maintainable and avoids duplicating workflow YAML.
  • The guide distinguishes current manual steps from future automation opportunities.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

Released

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions