diff --git a/v1.19/_images/user/protection/branch-protect.png b/v1.19/_images/user/protection/branch-protect.png new file mode 100644 index 00000000..0487773e Binary files /dev/null and b/v1.19/_images/user/protection/branch-protect.png differ diff --git a/v1.19/user/index.md b/v1.19/user/index.md index 2e4595fd..2e9a3894 100644 --- a/v1.19/user/index.md +++ b/v1.19/user/index.md @@ -7,6 +7,7 @@ These documents are targeted to people who are using Forgejo but are not involved in running it on their machines. - [Your First Repository](first-repository) +- [Branch and tag protection](protection) - [Webhooks](webhooks) - Authentication - [LDAP, PAM, FreeIPA](authentication) diff --git a/v1.19/user/protection.md b/v1.19/user/protection.md new file mode 100644 index 00000000..ce5f81ea --- /dev/null +++ b/v1.19/user/protection.md @@ -0,0 +1,62 @@ +--- +layout: '~/layouts/Markdown.astro' +title: 'Branch and tag protection' +license: 'Apache-2.0' +origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/advanced/protected-tags.en-us.md' +--- + +# Protected branches + +Protected branches enforce restrictions such as force pushing or +merging unless a given number of approval are obtained on a pull +request. + +To protect a branch, you need to go to the repository’s **Settings** > +**Branch** page and add a new rule. + +![Add a new rule](../../../../images/v1.19/user/protection/branch-protect.png) + +The name of the branch can be a glob where / is the separator and ** +spans accross separators. For instance `main`, `release/**` or `precious*`. + +If two rules apply to the same branch, the one that has no glob takes +precedence. + +# Protected tags + +Protected tags allow control over who has permission to create or update Git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once. + +## Setting up protected tags + +To protect a tag, you need to follow these steps: + +1. Go to the repository’s **Settings** > **Tags** page. +1. Type a pattern to match a name. You can use a single name, a [glob pattern](https://pkg.go.dev/github.com/gobwas/glob#Compile) or a regular expression. +1. Choose the allowed users and/or teams. If you leave these fields empty no one is allowed to create or modify this tag. +1. Select **Save** to save the configuration. + +## Pattern protected tags + +The pattern uses [glob](https://pkg.go.dev/github.com/gobwas/glob#Compile) or regular expressions to match a tag name. For regular expressions you need to enclose the pattern in slashes. + +Examples: + +| Type | Pattern Protected Tag | Possible Matching Tags | +| ----- | ------------------------ | --------------------------------------- | +| Glob | `v*` | `v`, `v-1`, `version2` | +| Glob | `v[0-9]` | `v0`, `v1` up to `v9` | +| Glob | `*-release` | `2.1-release`, `final-release` | +| Glob | `forgejo` | only `forgejo` | +| Glob | `*forgejo*` | `forgejo`, `2.1-forgejo`, `1_forgejo-r` | +| Glob | `{v,rel}-*` | `v-`, `v-1`, `v-final`, `rel-`, `rel-x` | +| Glob | `*` | matches all possible tag names | +| Regex | `/\Av/` | `v`, `v-1`, `version2` | +| Regex | `/\Av[0-9]\z/` | `v0`, `v1` up to `v9` | +| Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`, `v2.1.0` | +| Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`, `v2.1`, `v1.2.34` | +| Regex | `/-release\z/` | `2.1-release`, `final-release` | +| Regex | `/forgejo/` | `forgejo`, `2.1-forgejo`, `1_forgejo-r` | +| Regex | `/\Aforgejo\z/` | only `forgejo` | +| Regex | `/^forgejo$/` | only `forgejo` | +| Regex | `/\A(v\|rel)-/` | `v-`, `v-1`, `v-final`, `rel-`, `rel-x` | +| Regex | `/.+/` | matches all possible tag names |