Skip to content

Promote CI workflow documentation #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sumitdipsite2005 merged 1 commit into from
Sep 29, 2026
Merged

Promote CI workflow documentation #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion DEVELOPMENT_WORKFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The following GitHub rulesets are active:
- Targets only the default branch, `main`.
- Requires changes to reach `main` through a pull request.
- Requires 0 approving reviews, which keeps the workflow usable for a solo maintainer.
- Requires the `tests` status check from the `recorder-tests` GitHub Actions workflow to pass before merging.
- Allows merge, squash, or rebase at the GitHub ruleset level.
- Prevents deletion of `main`.
- Prevents non-fast-forward history rewrites of `main`.
Expand All @@ -59,13 +60,14 @@ The following GitHub rulesets are active:
- Targets only `dev`.
- Requires changes to reach `dev` through a pull request.
- Requires 0 approving reviews.
- Requires the `tests` status check from the `recorder-tests` GitHub Actions workflow to pass before merging.
- Allows **squash merge only**.
- Prevents deletion of `dev`.
- Prevents non-fast-forward history rewrites of `dev`.

Temporary feature/fix/chore branches are intentionally left unrestricted so iterative work can proceed freely there.

When required CI checks are added or changed in the future, the protection rules should be reviewed so protected-branch integration continues to reflect the project's actual validation requirements.
The required `tests` check is enforced on both protected branches. If CI jobs or validation requirements change in the future, the rulesets and this document should be reviewed together so the enforced checks continue to match the project's actual test workflow.

## Releases and versioning

Expand Down
Loading