forked from Shiloh/githaven
12cb1d2998
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:  <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>
125 lines
7.4 KiB
Go
125 lines
7.4 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package structs
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
// Branch represents a repository branch
|
|
type Branch struct {
|
|
Name string `json:"name"`
|
|
Commit *PayloadCommit `json:"commit"`
|
|
Protected bool `json:"protected"`
|
|
RequiredApprovals int64 `json:"required_approvals"`
|
|
EnableStatusCheck bool `json:"enable_status_check"`
|
|
StatusCheckContexts []string `json:"status_check_contexts"`
|
|
UserCanPush bool `json:"user_can_push"`
|
|
UserCanMerge bool `json:"user_can_merge"`
|
|
EffectiveBranchProtectionName string `json:"effective_branch_protection_name"`
|
|
}
|
|
|
|
// BranchProtection represents a branch protection for a repository
|
|
type BranchProtection struct {
|
|
// Deprecated: true
|
|
BranchName string `json:"branch_name"`
|
|
RuleName string `json:"rule_name"`
|
|
EnablePush bool `json:"enable_push"`
|
|
EnablePushWhitelist bool `json:"enable_push_whitelist"`
|
|
PushWhitelistUsernames []string `json:"push_whitelist_usernames"`
|
|
PushWhitelistTeams []string `json:"push_whitelist_teams"`
|
|
PushWhitelistDeployKeys bool `json:"push_whitelist_deploy_keys"`
|
|
EnableForcePush bool `json:"enable_force_push"`
|
|
EnableForcePushAllowlist bool `json:"enable_force_push_allowlist"`
|
|
ForcePushAllowlistUsernames []string `json:"force_push_allowlist_usernames"`
|
|
ForcePushAllowlistTeams []string `json:"force_push_allowlist_teams"`
|
|
ForcePushAllowlistDeployKeys bool `json:"force_push_allowlist_deploy_keys"`
|
|
EnableMergeWhitelist bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableStatusCheck bool `json:"enable_status_check"`
|
|
StatusCheckContexts []string `json:"status_check_contexts"`
|
|
RequiredApprovals int64 `json:"required_approvals"`
|
|
EnableApprovalsWhitelist bool `json:"enable_approvals_whitelist"`
|
|
ApprovalsWhitelistUsernames []string `json:"approvals_whitelist_username"`
|
|
ApprovalsWhitelistTeams []string `json:"approvals_whitelist_teams"`
|
|
BlockOnRejectedReviews bool `json:"block_on_rejected_reviews"`
|
|
BlockOnOfficialReviewRequests bool `json:"block_on_official_review_requests"`
|
|
BlockOnOutdatedBranch bool `json:"block_on_outdated_branch"`
|
|
DismissStaleApprovals bool `json:"dismiss_stale_approvals"`
|
|
IgnoreStaleApprovals bool `json:"ignore_stale_approvals"`
|
|
RequireSignedCommits bool `json:"require_signed_commits"`
|
|
ProtectedFilePatterns string `json:"protected_file_patterns"`
|
|
UnprotectedFilePatterns string `json:"unprotected_file_patterns"`
|
|
// swagger:strfmt date-time
|
|
Created time.Time `json:"created_at"`
|
|
// swagger:strfmt date-time
|
|
Updated time.Time `json:"updated_at"`
|
|
}
|
|
|
|
// CreateBranchProtectionOption options for creating a branch protection
|
|
type CreateBranchProtectionOption struct {
|
|
// Deprecated: true
|
|
BranchName string `json:"branch_name"`
|
|
RuleName string `json:"rule_name"`
|
|
EnablePush bool `json:"enable_push"`
|
|
EnablePushWhitelist bool `json:"enable_push_whitelist"`
|
|
PushWhitelistUsernames []string `json:"push_whitelist_usernames"`
|
|
PushWhitelistTeams []string `json:"push_whitelist_teams"`
|
|
PushWhitelistDeployKeys bool `json:"push_whitelist_deploy_keys"`
|
|
EnableForcePush bool `json:"enable_force_push"`
|
|
EnableForcePushAllowlist bool `json:"enable_force_push_allowlist"`
|
|
ForcePushAllowlistUsernames []string `json:"force_push_allowlist_usernames"`
|
|
ForcePushAllowlistTeams []string `json:"force_push_allowlist_teams"`
|
|
ForcePushAllowlistDeployKeys bool `json:"force_push_allowlist_deploy_keys"`
|
|
EnableMergeWhitelist bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableStatusCheck bool `json:"enable_status_check"`
|
|
StatusCheckContexts []string `json:"status_check_contexts"`
|
|
RequiredApprovals int64 `json:"required_approvals"`
|
|
EnableApprovalsWhitelist bool `json:"enable_approvals_whitelist"`
|
|
ApprovalsWhitelistUsernames []string `json:"approvals_whitelist_username"`
|
|
ApprovalsWhitelistTeams []string `json:"approvals_whitelist_teams"`
|
|
BlockOnRejectedReviews bool `json:"block_on_rejected_reviews"`
|
|
BlockOnOfficialReviewRequests bool `json:"block_on_official_review_requests"`
|
|
BlockOnOutdatedBranch bool `json:"block_on_outdated_branch"`
|
|
DismissStaleApprovals bool `json:"dismiss_stale_approvals"`
|
|
IgnoreStaleApprovals bool `json:"ignore_stale_approvals"`
|
|
RequireSignedCommits bool `json:"require_signed_commits"`
|
|
ProtectedFilePatterns string `json:"protected_file_patterns"`
|
|
UnprotectedFilePatterns string `json:"unprotected_file_patterns"`
|
|
}
|
|
|
|
// EditBranchProtectionOption options for editing a branch protection
|
|
type EditBranchProtectionOption struct {
|
|
EnablePush *bool `json:"enable_push"`
|
|
EnablePushWhitelist *bool `json:"enable_push_whitelist"`
|
|
PushWhitelistUsernames []string `json:"push_whitelist_usernames"`
|
|
PushWhitelistTeams []string `json:"push_whitelist_teams"`
|
|
PushWhitelistDeployKeys *bool `json:"push_whitelist_deploy_keys"`
|
|
EnableForcePush *bool `json:"enable_force_push"`
|
|
EnableForcePushAllowlist *bool `json:"enable_force_push_allowlist"`
|
|
ForcePushAllowlistUsernames []string `json:"force_push_allowlist_usernames"`
|
|
ForcePushAllowlistTeams []string `json:"force_push_allowlist_teams"`
|
|
ForcePushAllowlistDeployKeys *bool `json:"force_push_allowlist_deploy_keys"`
|
|
EnableMergeWhitelist *bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableStatusCheck *bool `json:"enable_status_check"`
|
|
StatusCheckContexts []string `json:"status_check_contexts"`
|
|
RequiredApprovals *int64 `json:"required_approvals"`
|
|
EnableApprovalsWhitelist *bool `json:"enable_approvals_whitelist"`
|
|
ApprovalsWhitelistUsernames []string `json:"approvals_whitelist_username"`
|
|
ApprovalsWhitelistTeams []string `json:"approvals_whitelist_teams"`
|
|
BlockOnRejectedReviews *bool `json:"block_on_rejected_reviews"`
|
|
BlockOnOfficialReviewRequests *bool `json:"block_on_official_review_requests"`
|
|
BlockOnOutdatedBranch *bool `json:"block_on_outdated_branch"`
|
|
DismissStaleApprovals *bool `json:"dismiss_stale_approvals"`
|
|
IgnoreStaleApprovals *bool `json:"ignore_stale_approvals"`
|
|
RequireSignedCommits *bool `json:"require_signed_commits"`
|
|
ProtectedFilePatterns *string `json:"protected_file_patterns"`
|
|
UnprotectedFilePatterns *string `json:"unprotected_file_patterns"`
|
|
}
|