Skip to content

Commit a07bd29

Browse files
venc0rtechknowlogick
venc0r
authored and
techknowlogick
committed
feat: add branch_protection resource (#72)
added terraform tests for the resource Reviewed-on: https://gitea.com/gitea/terraform-provider-gitea/pulls/72 Co-authored-by: Jörg Markert <[email protected]> Co-committed-by: Jörg Markert <[email protected]>
1 parent aa450c1 commit a07bd29

15 files changed

+1133
-15
lines changed

‎.gitea/workflows/test.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ jobs:
2222
- name: Terraform Init
2323
id: init
2424
run: terraform init
25+
working-directory: examples
2526

2627
- name: Terraform Validate
2728
id: validate
28-
run: terraform validate -no-color
29+
run: terraform validate -no-color
30+
working-directory: examples

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
.vscode
22
.idea/
33
dist/
4+
tests/terraform.tfvars
5+
tests/.terraform
6+
tests/.terraform.lock.hcl

‎docs/resources/repository_branch_protection.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitea_repository_branch_protection Resource - terraform-provider-gitea"
4+
subcategory: ""
5+
description: |-
6+
This resource allows you to create and manage branch protections for repositories.
7+
---
8+
9+
# gitea_repository_branch_protection (Resource)
10+
11+
This resource allows you to create and manage branch protections for repositories.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) Repository name
21+
- `rule_name` (String) Protected Branch Name Pattern
22+
- `username` (String) User name or organization name
23+
24+
### Optional
25+
26+
- `approval_whitelist_teams` (List of String) Only reviews from allowlisted teams will count to the required
27+
approvals. Without approval allowlist, reviews from anyone with
28+
write access count to the required approvals.
29+
- `approval_whitelist_users` (List of String) Only reviews from allowlisted users will count to the required
30+
approvals. Without approval allowlist, reviews from anyone with
31+
write access count to the required approvals.
32+
- `block_merge_on_official_review_requests` (Boolean) Merging will not be possible when it has official
33+
review requests, even if there are enough approvals.
34+
- `block_merge_on_outdated_branch` (Boolean) Merging will not be possible when head branch is behind base branch.
35+
- `block_merge_on_rejected_reviews` (Boolean) Merging will not be possible when changes are
36+
requested by official reviewers, even if there are enough
37+
approvals.
38+
- `dismiss_stale_approvals` (Boolean) When new commits that change the content of the pull request
39+
are pushed to the branch, old approvals will be dismissed.
40+
- `enable_push` (Boolean) Anyone with write access will be allowed to push to this branch
41+
(but not force push), add a whitelist users or teams to limit
42+
access.
43+
- `merge_whitelist_teams` (List of String) Allow only allowlisted teams to merge pull requests into this branch.
44+
- `merge_whitelist_users` (List of String) Allow only allowlisted users to merge pull requests into this branch.
45+
- `protected_file_patterns` (String) Protected file patterns (separated using semicolon ';')
46+
- `push_whitelist_deploy_keys` (Boolean) Allow deploy keys with write access to push. Requires enable_push to be set to true.
47+
- `push_whitelist_teams` (List of String) Allowlisted teams for pushing. Requires enable_push to be set to true.
48+
- `push_whitelist_users` (List of String) Allowlisted users for pushing. Requires enable_push to be set to true.
49+
- `require_signed_commits` (Boolean) Reject pushes to this branch if they are unsigned or unverifiable.
50+
- `required_approvals` (Number) Allow only to merge pull request with enough positive reviews.
51+
- `status_check_patterns` (List of String) Enter patterns to specify which status checks must pass before
52+
branches can be merged into a branch that matches this rule.
53+
Each line specifies a pattern. Patterns cannot be empty.
54+
- `unprotected_file_patterns` (String) Unprotected file patterns (separated using semicolon ';')
55+
56+
### Read-Only
57+
58+
- `created_at` (String) Webhook creation timestamp
59+
- `enable_approval_whitelist` (Boolean) True if a approval whitelist is used.
60+
- `enable_merge_whitelist` (Boolean) True if a merge whitelist is used.
61+
- `enable_push_whitelist` (Boolean) True if a push whitelist is used.
62+
- `enable_status_check` (Boolean) Require status checks to pass before merging. When enabled,
63+
commits must first be pushed to another branch, then merged
64+
or pushed directly to a branch that matches this rule after
65+
status checks have passed. If no contexts are matched, the
66+
last commit must be successful regardless of context
67+
- `id` (String) The ID of this resource.
68+
- `updated_at` (String) Webhook creation timestamp

‎examples/provider.tf

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ terraform {
22
required_providers {
33
gitea = {
44
source = "go-gitea/gitea"
5-
version = "0.1.0"
5+
version = "0.3.0"
66
}
77
}
88
}
@@ -12,4 +12,4 @@ provider "gitea" {
1212
username = "lerentis"
1313
password = var.gitea_password
1414
#token = var.gitea_token
15-
}
15+
}

‎examples/resources/gitea_repo_branch_protection/resource.tf

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
resource "gitea_repository" "repo" {
2+
username = var.username
3+
name = var.name
4+
auto_init = false
5+
}
6+
7+
resource "gitea_repository_branch_protection" "main" {
8+
username = gitea_repository.repo.username
9+
name = gitea_repository.repo.name
10+
11+
rule_name = "main"
12+
enable_push = true
13+
status_check_patterns = var.branch_protection_patterns
14+
}

‎gitea/provider.go

+13-12
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,19 @@ func Provider() *schema.Provider {
7575
"gitea_org": resourceGiteaOrg(),
7676
// "gitea_team": resourceGiteaTeam(),
7777
// "gitea_repo": resourceGiteaRepo(),
78-
"gitea_user": resourceGiteaUser(),
79-
"gitea_oauth2_app": resourceGiteaOauthApp(),
80-
"gitea_repository": resourceGiteaRepository(),
81-
"gitea_fork": resourceGiteaFork(),
82-
"gitea_public_key": resourceGiteaPublicKey(),
83-
"gitea_team": resourceGiteaTeam(),
84-
"gitea_team_membership": resourceGiteaTeamMembership(),
85-
"gitea_team_members": resourceGiteaTeamMembers(),
86-
"gitea_git_hook": resourceGiteaGitHook(),
87-
"gitea_token": resourceGiteaToken(),
88-
"gitea_repository_key": resourceGiteaRepositoryKey(),
89-
"gitea_repository_webhook": resourceGiteaRepositoryWebhook(),
78+
"gitea_user": resourceGiteaUser(),
79+
"gitea_oauth2_app": resourceGiteaOauthApp(),
80+
"gitea_repository": resourceGiteaRepository(),
81+
"gitea_fork": resourceGiteaFork(),
82+
"gitea_public_key": resourceGiteaPublicKey(),
83+
"gitea_team": resourceGiteaTeam(),
84+
"gitea_team_membership": resourceGiteaTeamMembership(),
85+
"gitea_team_members": resourceGiteaTeamMembers(),
86+
"gitea_git_hook": resourceGiteaGitHook(),
87+
"gitea_token": resourceGiteaToken(),
88+
"gitea_repository_key": resourceGiteaRepositoryKey(),
89+
"gitea_repository_webhook": resourceGiteaRepositoryWebhook(),
90+
"gitea_repository_branch_protection": resourceGiteaRepositoryBranchProtection(),
9091
},
9192

9293
ConfigureFunc: providerConfigure,

0 commit comments

Comments
 (0)