]> source.dussan.org Git - gitea.git/commit
Allow force push to protected branches (#28086)
authorHenry Goodman <79623665+henrygoodman@users.noreply.github.com>
Fri, 5 Jul 2024 18:21:56 +0000 (04:21 +1000)
committerGitHub <noreply@github.com>
Fri, 5 Jul 2024 18:21:56 +0000 (18:21 +0000)
commit12cb1d2998f2a307713ce979f8d585711e92061c
treec103d858c7083b3f320f261d657db6b23bcf2455
parent9c00dda33ad7bd594dd8f331fa1bf0acefc2ca54
Allow force push to protected branches (#28086)

Fixes #22722

### Problem
Currently, it is not possible to force push to a branch with branch
protection rules in place. There are often times where this is necessary
(CI workflows/administrative tasks etc).

The current workaround is to rename/remove the branch protection,
perform the force push, and then reinstate the protections.

### Solution
Provide an additional section in the branch protection rules to allow
users to specify which users with push access can also force push to the
branch. The default value of the rule will be set to `Disabled`, and the
UI is intuitive and very similar to the `Push` section.

It is worth noting in this implementation that allowing force push does
not override regular push access, and both will need to be enabled for a
user to force push.

This applies to manual force push to a remote, and also in Gitea UI
updating a PR by rebase (which requires force push)

This modifies the `BranchProtection` API structs to add:
- `enable_force_push bool`
- `enable_force_push_whitelist bool`
- `force_push_whitelist_usernames string[]`
- `force_push_whitelist_teams string[]`
- `force_push_whitelist_deploy_keys bool`

### Updated Branch Protection UI:

<img width="943" alt="image"
src="https://github.com/go-gitea/gitea/assets/79623665/7491899c-d816-45d5-be84-8512abd156bf">

### Pull Request `Update branch by Rebase` option enabled with source
branch `test` being a protected branch:

![image](https://github.com/go-gitea/gitea/assets/79623665/e018e6e9-b7b2-4bd3-808e-4947d7da35cc)
<img width="1038" alt="image"
src="https://github.com/go-gitea/gitea/assets/79623665/57ead13e-9006-459f-b83c-7079e6f4c654">

---------

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
14 files changed:
models/git/protected_branch.go
models/migrations/migrations.go
models/migrations/v1_23/v300.go [new file with mode: 0644]
modules/structs/repo_branch.go
options/locale/locale_en-US.ini
routers/api/v1/repo/branch.go
routers/private/hook_pre_receive.go
routers/web/repo/setting/protected_branch.go
services/convert/convert.go
services/forms/repo_form.go
services/pull/update.go
templates/repo/settings/protected_branch.tmpl
templates/swagger/v1_json.tmpl
tests/integration/git_test.go