Skip to content

Docs/branch workflow requirements#15

Merged
github-actions[bot] merged 3 commits intomainfrom
docs/branch-workflow-requirements
Jan 13, 2026
Merged

Docs/branch workflow requirements#15
github-actions[bot] merged 3 commits intomainfrom
docs/branch-workflow-requirements

Conversation

@genezhang
Copy link
Copy Markdown
Owner

This pull request updates the branch protection documentation and the auto-approve workflow to enforce a stricter, review-focused process for merging changes into the main branch. The main goal is to require manual, human review for all pull requests—including documentation and configuration changes—by disabling auto-merge and clarifying the required branch protection settings.

Branch protection policy and workflow updates:

  • Added a comprehensive .github/BRANCH_PROTECTION_SETUP.md file detailing required branch protection rules, manual review requirements, and steps for emergency overrides. This includes instructions for disabling auto-merge and ensuring all merges to main go through human review.
  • Updated .github/workflows/auto-approve.yml to clarify that auto-merge is disabled, and renamed the workflow to "Auto Approve Documentation Changes" to better reflect current behavior.
  • Modified the auto-approve workflow to:
    • Update the approval message to state that human review is still required before merging.
    • Remove the auto-merge job, with clear comments explaining how to re-enable it if needed.

These changes ensure that even documentation and configuration updates receive proper review, aligning with the project's updated development process and security standards.

BREAKING CHANGE: All development must now follow branch-based workflow

Changes:
- Add Phase 0 (Create Branch) and Phase 6 (PR & Merge) to development process
- Update from 5-phase to 6-phase development workflow
- Rewrite git-workflow.md with branch-first approach
- Emphasize bug fixes/improvements as primary work (late-stage development)
- Add branch naming conventions with frequency indicators
- Add pre-PR checklist and code review guidelines
- Add quick reference for bug fix workflow
- Establish absolute rules: never commit to main, always use PRs

Updated files:
- DEVELOPMENT_PROCESS.md: Added Phase 0 and Phase 6, bug fix quick reference
- docs/development/git-workflow.md: Complete rewrite with PR-first workflow

Note: copilot-instructions.md updated locally but not committed (internal use only)

Impact: All future development must create branches and submit PRs for review
Auto-merge conflicted with new branch workflow requirements that mandate
human code review for all PRs.

Changes:
- Disabled auto-merge job in auto-approve.yml workflow
- Bot will still auto-approve docs-only PRs
- But manual human review and merge is now REQUIRED
- Updated workflow comments to explain the policy
- Old workflow backed up as auto-approve-OLD.yml.bak

Reason: All PRs must be reviewed by a human before merging to main,
as established in the new development process (Phase 6)
Complete guide for configuring GitHub branch protection rules to enforce
the new PR workflow requirements.

Includes:
- Step-by-step UI configuration instructions
- Required settings for main branch protection
- Test procedures to verify protection works
- Emergency override procedures
- FAQ for common scenarios
- Explanation of why auto-merge is disabled

This is a manual step that must be done via GitHub Settings UI.
@github-actions github-actions Bot merged commit d300d71 into main Jan 13, 2026
2 of 3 checks passed
@genezhang genezhang deleted the docs/branch-workflow-requirements branch January 14, 2026 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant