Skip to content

Add automation governance and release strategy doc - #7

Merged
ashleyshaw merged 1 commit into
mainfrom
develop
Oct 10, 2025
Merged

Add automation governance and release strategy doc#7
ashleyshaw merged 1 commit into
mainfrom
develop

Conversation

@ashleyshaw

@ashleyshawashleyshaw commented Oct 10, 2025

Copy link
Copy Markdown
Member

Introduces AUTOMATION_GOVERNANCE.md outlining standards for changelog enforcement, release automation, labelling, branching, and project sync across all LightSpeed repositories. Provides detailed policies, recommended workflows, and references for maintainers and contributors.

Summary by CodeRabbit

  • Documentation
    • Introduced a centralised automation governance guide outlining org-wide policies and workflows for changelogs, release automation, labelling, project syncing, and branching discipline.
    • Covers principles (automation-first, standard workflows, semantic versioning), required PR/CI checks, release steps (validation, tagging, publishing), label rules and colour consistency, changelog format and version-bump triggers, example tool configurations, project field alignment, secrets/permissions guidance, rollout plan, and maintainer usage notes.

Introduces AUTOMATION_GOVERNANCE.md outlining standards for changelog enforcement, release automation, labelling, branching, and project sync across all LightSpeed repositories. Provides detailed policies, recommended workflows, and references for maintainers and contributors.
@github-actionsgithub-actionsBot added documentation lang:md Markdown content/docs labels Oct 10, 2025
@ashleyshaw
ashleyshaw merged commit e8e5641 into mainOct 10, 2025
5 of 7 checks passed
@coderabbitai

coderabbitaiBot commented Oct 10, 2025

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new org-wide documentation file, AUTOMATION_GOVERNANCE.md, defining policies and workflows for changelogs, releases, labelling, project syncing, branching, CI checks, secrets/permissions, rollout, and usage guidance across LightSpeed repositories.

Changes

Cohort / File(s)Summary
Documentation: Governance
AUTOMATION_GOVERNANCE.md
New governance document outlining automation-first principles, required workflows (changelog enforcement, release automation, labelling, project updates), branching conventions, CI checks, changelog format, versioning triggers, tool configs, secrets/permissions, rollout, and references.

Sequence Diagram(s)

sequenceDiagram
autonumber
actor Dev as Developer
participant Repo as Repo (PR/CI)
participant Auto as Automation Bot
participant GH as GitHub Releases
participant Project as Project Board
rect rgba(230,245,255,0.5)
note over Dev,Repo: PR Creation & Changelog Enforcement
Dev->>Repo: Open PR with template
Repo->>Repo: CI checks changelog Unreleased entry
Repo-->>Dev: Pass/Fail status
end
rect rgba(235,255,235,0.5)
note over Auto: Labelling & Sync
Repo->>Auto: PR event (open/sync/merge)
Auto->>Auto: Apply labels (type/branch)
Auto->>Project: Update fields/status
end
rect rgba(255,245,230,0.5)
note over Dev,Auto: Release Automation
Dev->>Auto: Trigger release (label/version)
Auto->>Repo: Validate changelog format
Auto->>Auto: Determine version (semver, BREAKING CHANGE)
Auto->>Repo: Move Unreleased -> dated section
Auto->>GH: Create tag and GitHub Release
Auto->>GH: Attach artefacts (optional)
Auto-->>Repo: Status output
end
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump my paws in tidy cheer,
New rules align our burrows here.
Labels hop, releases flow,
Changelogs sprout in ordered rows.
With whiskered wit and CI light,
We ship at dawn, tails tucked tight. 🐇✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch develop

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 675b97c and 1696ceb.

📒 Files selected for processing (1)
  • AUTOMATION_GOVERNANCE.md (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot mentioned this pull request Oct 12, 2025
9 tasks
ashleyshaw added a commit that referenced this pull request Aug 11, 2026
- Fix#1: Positional mode validation — reject unsupported modes like 'typo'
- Fix#2: Days input validation — reject NaN, non-integer, and non-positive values
- Fix#3: Script validation — reject unknown scripts and mode-incompatible selections
- Fix#4: Output file reporting — stop claiming output was saved when handlers don't write
- Fix#5: Exit status — exit with code 1 when any handler fails
- Fix#6: Dry-run consistency — honor --dry-run flag in apply mode (was hardcoded false)
- Fix#7: Test quality — replace literal assertions with logic tests for orchestrator behaviour
Test coverage expanded from 29 to 33 tests covering all fixes.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
ashleyshaw added a commit that referenced this pull request Aug 11, 2026
- Fix#1: Positional mode validation — reject unsupported modes like 'typo'
- Fix#2: Days input validation — reject NaN, non-integer, and non-positive values
- Fix#3: Script validation — reject unknown scripts and mode-incompatible selections
- Fix#4: Output file reporting — stop claiming output was saved when handlers don't write
- Fix#5: Exit status — exit with code 1 when any handler fails
- Fix#6: Dry-run consistency — honor --dry-run flag in apply mode (was hardcoded false)
- Fix#7: Test quality — replace literal assertions with logic tests for orchestrator behaviour
Test coverage expanded from 29 to 33 tests covering all fixes.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
ashleyshaw added a commit that referenced this pull request Aug 11, 2026
* docs: Add Phase 2 Label Orchestrator changelog entry
Added comprehensive changelog entry documenting Phase 2 label-orchestrator CLI
implementation, including three operating modes (audit, sync, apply), input
validation, mode-specific constraints, dry-run defaults, and test coverage.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* feat: Phase 2 - Unified label orchestrator CLI
- Add label-orchestrator.js: unified CLI for all label management scripts
- Support modes: audit (analyse), sync (synchronise dry-run), apply (live changes)
- Unified reporting, progress tracking, and error handling
- 29 unit tests for argument parsing, validation, and mode dispatch
- Orchestrates manage-stale-issues, review-meta-labels, review-status-labels, sync-pr-labels
Resolves#1720 (Create Shared Utilities - Phase 2 expansion)
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* fix: Address 7 CodeRabbit review issues in Phase 2 orchestrator
- Fix#1: Positional mode validation — reject unsupported modes like 'typo'
- Fix#2: Days input validation — reject NaN, non-integer, and non-positive values
- Fix#3: Script validation — reject unknown scripts and mode-incompatible selections
- Fix#4: Output file reporting — stop claiming output was saved when handlers don't write
- Fix#5: Exit status — exit with code 1 when any handler fails
- Fix#6: Dry-run consistency — honor --dry-run flag in apply mode (was hardcoded false)
- Fix#7: Test quality — replace literal assertions with logic tests for orchestrator behaviour
Test coverage expanded from 29 to 33 tests covering all fixes.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* fix: Eliminate trivial test conditions from exit status tests
- Line 217: Replace always-false condition with direct exitCode = 0
- Line 223: Replace always-true condition with realistic error array
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* fix: Use errorCount in success test to eliminate unused variable
Restore the ternary condition in the success test to match the error test pattern,
making both tests consistent and eliminating the unused errorCount variable.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* fix: Remove unused errorCount variable from success test
Removed unused errorCount declaration that was causing ESLint warning.
The success test now directly asserts exitCode = 0 without intermediate variable.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lang:mdMarkdown content/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ashleyshaw