From 66399e49c72e67b97f6b8a0cad5f1d9445fd6578 Mon Sep 17 00:00:00 2001 From: Luis Alvergue Date: Thu, 1 Aug 2024 20:04:11 +0000 Subject: [PATCH] docs(branches): update branches docs due to tag-based releases --- docs/development/commits-branches-merging.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/development/commits-branches-merging.md b/docs/development/commits-branches-merging.md index 034360232..63e2ee8c7 100644 --- a/docs/development/commits-branches-merging.md +++ b/docs/development/commits-branches-merging.md @@ -37,18 +37,23 @@ base. In addition to `main`, the repository has three other long-lived branches: -- `test` and `prod` correspond to the Test and Production [deploy environments](../deployment/README.md), respectively. +- `test` and `prod` are read-only (no longer actively used) and correspond to the Test and Production [deploy environments](../deployment/README.md), respectively. The last release using these branches was [2024.07.1](https://github.com/cal-itp/benefits/releases/tag/2024.07.1). - `gh-pages` hosts the compiled documentation, and is always forced-pushed by the [docs build process](../getting-started/documentation.md#deploying). ### Protection rules -[Branch protection rules][gh-branch-protection] are in place on three environment branches (`main`, `test`, `prod`) to: +[Branch protection rules][gh-branch-protection] are in place on `main` to: - Prevent branch deletion - Restrict force-pushing, where appropriate - Require passing status checks before merging into the target branch is allowed +[Branch protection rules][gh-branch-protection] are in place on `test` and `prod` to: + +- Prevent branch deletion +- Lock the branch, making it read-only so that users cannot push to the branch since the branch is no longer used + ### PR branches PR branches are typically named with a [conventional type][conventional-commits] prefix, a slash `/`, and then descriptor in `lower-dashed-case`: