docs: document uat → main branch workflow#111
Conversation
- Add Branch workflow section explaining two-tier model - uat is now the default branch for PRs and integration testing - main only accepts merges from uat via PR - Update branching instructions to create branches from uat
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b59a505f3c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| **Workflow:** | ||
| 1. Create feature branches from `uat`: `feature/your-feature` or `fix/your-fix` | ||
| 2. Submit PR targeting `uat` (default) |
There was a problem hiding this comment.
Align documented PR target with workflow branch filters
This change instructs contributors to open feature PRs against uat, but the current CI workflows are still filtered to main only (for example, .github/workflows/ci.yml, lint.yml, and govulncheck.yml use pull_request.branches: ["main"]). As a result, PRs that follow this new guidance will not run the normal automated checks, which weakens the stated uat validation step and delays detection of regressions until a later uat -> main PR.
Useful? React with 👍 / 👎.
Document the new two-tier branching model:
uatis now the default branch for integration testinguatfirstmainonly accepts merges fromuatThis establishes a clear path for changes to go through integration testing before reaching the stable
mainbranch.