mirror of
https://github.com/go-gitea/gitea.git
synced 2026-11-19 15:14:40 +09:00
The branch protection API handled push and force push options
inconsistently. Create dropped force push unless push was enabled, and
edit ignored allowlist fields unless their parent was set to true in the
same request.
- Create treats force push independently of push, like edit and the web
UI. Enforcement is unchanged.
- Edit applies `enable_push_whitelist`, `enable_force_push_allowlist`
and both deploy key flags against the rule's resulting state, like the
deletion fields. `{"enable_push_whitelist": false}` now disables the
whitelist instead of being ignored.
- Documents that `enable_force_push_allowlist` requires
`enable_force_push` on create.
Fixes https://github.com/go-gitea/gitea/issues/35121
---------
Co-authored-by: silverwind <me@silverwind.io>
181 lines
10 KiB
Go
181 lines
10 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 is the branch name
|
|
Name string `json:"name"`
|
|
// Commit contains the latest commit information for this branch
|
|
Commit *PayloadCommit `json:"commit"`
|
|
// Protected indicates if the branch is protected
|
|
Protected bool `json:"protected"`
|
|
// RequiredApprovals is the number of required approvals for pull requests
|
|
RequiredApprovals int64 `json:"required_approvals"`
|
|
// EnableStatusCheck indicates if status checks are enabled
|
|
EnableStatusCheck bool `json:"enable_status_check"`
|
|
// StatusCheckContexts contains the list of required status check contexts
|
|
StatusCheckContexts []string `json:"status_check_contexts"`
|
|
// UserCanPush indicates if the current user can push to this branch
|
|
UserCanPush bool `json:"user_can_push"`
|
|
// UserCanMerge indicates if the current user can merge to this branch
|
|
UserCanMerge bool `json:"user_can_merge"`
|
|
// EffectiveBranchProtectionName is the name of the effective branch protection rule
|
|
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 is the name of the branch protection rule
|
|
RuleName string `json:"rule_name"`
|
|
// Priority is the priority of this branch protection rule
|
|
Priority int64 `json:"priority"`
|
|
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"`
|
|
EnableDeletion bool `json:"enable_deletion"`
|
|
EnableDeletionAllowlist bool `json:"enable_deletion_allowlist"`
|
|
DeletionAllowlistUsernames []string `json:"deletion_allowlist_usernames"`
|
|
DeletionAllowlistTeams []string `json:"deletion_allowlist_teams"`
|
|
EnableMergeWhitelist bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableBypassAllowlist bool `json:"enable_bypass_allowlist"`
|
|
BypassAllowlistUsernames []string `json:"bypass_allowlist_usernames"`
|
|
BypassAllowlistTeams []string `json:"bypass_allowlist_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"`
|
|
BlockOnCodeownerReviews bool `json:"block_on_codeowner_reviews"`
|
|
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"`
|
|
BlockAdminMergeOverride bool `json:"block_admin_merge_override"`
|
|
// 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"`
|
|
Priority int64 `json:"priority"`
|
|
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 only takes effect when enable_force_push is true
|
|
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"`
|
|
EnableDeletion bool `json:"enable_deletion"`
|
|
EnableDeletionAllowlist bool `json:"enable_deletion_allowlist"`
|
|
DeletionAllowlistUsernames []string `json:"deletion_allowlist_usernames"`
|
|
DeletionAllowlistTeams []string `json:"deletion_allowlist_teams"`
|
|
EnableMergeWhitelist bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableBypassAllowlist bool `json:"enable_bypass_allowlist"`
|
|
BypassAllowlistUsernames []string `json:"bypass_allowlist_usernames"`
|
|
BypassAllowlistTeams []string `json:"bypass_allowlist_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"`
|
|
BlockOnCodeownerReviews bool `json:"block_on_codeowner_reviews"`
|
|
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"`
|
|
BlockAdminMergeOverride bool `json:"block_admin_merge_override"`
|
|
}
|
|
|
|
// EditBranchProtectionOption options for editing a branch protection
|
|
type EditBranchProtectionOption struct {
|
|
Priority *int64 `json:"priority"`
|
|
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"`
|
|
EnableDeletion *bool `json:"enable_deletion"`
|
|
EnableDeletionAllowlist *bool `json:"enable_deletion_allowlist"`
|
|
DeletionAllowlistUsernames []string `json:"deletion_allowlist_usernames"`
|
|
DeletionAllowlistTeams []string `json:"deletion_allowlist_teams"`
|
|
EnableMergeWhitelist *bool `json:"enable_merge_whitelist"`
|
|
MergeWhitelistUsernames []string `json:"merge_whitelist_usernames"`
|
|
MergeWhitelistTeams []string `json:"merge_whitelist_teams"`
|
|
EnableBypassAllowlist *bool `json:"enable_bypass_allowlist"`
|
|
BypassAllowlistUsernames []string `json:"bypass_allowlist_usernames"`
|
|
BypassAllowlistTeams []string `json:"bypass_allowlist_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"`
|
|
BlockOnCodeownerReviews *bool `json:"block_on_codeowner_reviews"`
|
|
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"`
|
|
BlockAdminMergeOverride *bool `json:"block_admin_merge_override"`
|
|
}
|
|
|
|
// UpdateBranchProtectionPriories a list to update the branch protection rule priorities
|
|
type UpdateBranchProtectionPriories struct {
|
|
IDs []int64 `json:"ids"`
|
|
}
|
|
|
|
type MergeUpstreamRequest struct {
|
|
Branch string `json:"branch"`
|
|
FfOnly bool `json:"ff_only"`
|
|
}
|
|
|
|
type MergeUpstreamResponse struct {
|
|
MergeStyle string `json:"merge_type"`
|
|
}
|