forgejo/modules/structs/repo_branch.go

// Copyright 2016 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

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 {
	BranchName                  string   `json:"branch_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"`
	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"`
	DismissStaleApprovals       bool     `json:"dismiss_stale_approvals"`
	RequireSignedCommits        bool     `json:"require_signed_commits"`
	ProtectedFilePatterns       string   `json:"protected_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 {
	BranchName                  string   `json:"branch_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"`
	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"`
	DismissStaleApprovals       bool     `json:"dismiss_stale_approvals"`
	RequireSignedCommits        bool     `json:"require_signed_commits"`
	ProtectedFilePatterns       string   `json:"protected_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"`
	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"`
	DismissStaleApprovals       *bool    `json:"dismiss_stale_approvals"`
	RequireSignedCommits        *bool    `json:"require_signed_commits"`
	ProtectedFilePatterns       *string  `json:"protected_file_patterns"`
}