Skip to content

Document branch protection and bot commit workflows #61

@coisa

Description

@coisa

Objective

Document how branch protection, bot commits, wiki previews, and report previews interact in the Fast Forward development workflow.

Current Limitation

Recent workflow changes rely on PR-scoped previews, bot commits to PR branches, and post-merge publishing. Maintainers need clear documentation for why these flows exist, what permissions are required, and how to resolve common conflicts or blocked merges.

Proposed Work

Add documentation that explains the protected-branch-safe automation model for wiki and reports publishing.

Scope

  • Explain why generated wiki content is committed to a PR-scoped wiki branch before merge.
  • Explain why the parent repository receives bot commits updating .github/wiki during PR previews.
  • Explain what happens after merge into main.
  • Document common conflict resolution for .github/wiki submodule pointer conflicts.
  • Document report preview access and fallback artifacts.
  • Document required workflow permissions at a high level.

Non-goals

  • Changing workflow behavior.
  • Documenting every GitHub Actions implementation detail.
  • Replacing command reference documentation.

Acceptance Criteria

Delivery Criteria

  • Documentation explains the wiki preview and publish lifecycle.
  • Documentation explains report preview and production Pages deployment behavior.
  • Documentation covers bot commits and branch protection interactions.
  • Documentation includes a short conflict-resolution guide for .github/wiki pointer conflicts.
  • Documentation links from an existing GitHub Actions or consumer automation page.

Architectural / Isolation Criteria

  • Documentation uses repository terminology consistently.
  • The page avoids implementation details likely to drift unless linked to the workflow files.
  • Examples use concrete branch names such as main, master, and pr-<number> where relevant.

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