Skip to content

Commit 4b1a4af

Browse files
emmavioletgithub-actionsdavidstahelihubwriter
authored
Adds docs for new tag protection rules feature (#25461)
* Adds docs for configuring tag protection rules * Adds beta note * Optimize images * Use correct terminology for permissions Co-authored-by: David Staheli <[email protected]> * Removes public from beta wording Co-authored-by: David Staheli <[email protected]> * Adds ommitted quotation * Add new article to the repositories category * Simplify language Co-authored-by: hubwriter <[email protected]> * Link to more information on repository roles Co-authored-by: hubwriter <[email protected]> * Clarify what protected tags are Co-authored-by: hubwriter <[email protected]> * Specify that repository roles only aid in management of protected tags Co-authored-by: hubwriter <[email protected]> * Add table rows for protected tags Co-authored-by: github-actions <[email protected]> Co-authored-by: David Staheli <[email protected]> Co-authored-by: hubwriter <[email protected]>
1 parent 10c4e03 commit 4b1a4af

File tree

7 files changed

+36
-1
lines changed

7 files changed

+36
-1
lines changed
Loading
Loading
Loading

content/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,9 @@ Some of the features listed below are limited to organizations using {% data var
111111
| Configure [a publishing source for {% data variables.product.prodname_pages %}](/articles/configuring-a-publishing-source-for-github-pages) | | | | **X** | **X** |
112112
| [Manage branch protection rules](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) | | | | | **X** |
113113
| [Push to protected branches](/articles/about-protected-branches) | | | | **X** | **X** |
114-
| Merge pull requests on protected branches, even if there are no approving reviews | | | | | **X** |
114+
| Merge pull requests on protected branches, even if there are no approving reviews | | | | | **X** |{% ifversion fpt or ghes > 3.4 or ghae-issue-6337 or ghec %}
115+
| Create tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | | | | **X** | **X** |
116+
| Delete tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | | | | | **X** |{% endif %}
115117
| [Create and edit repository social cards](/articles/customizing-your-repositorys-social-media-preview) | | | | **X** | **X** |{% ifversion fpt or ghec %}
116118
| Limit [interactions in a repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)| | | | **X** | **X** |{% endif %}
117119
| Delete an issue (see "[Deleting an issue](/articles/deleting-an-issue)") | | | | | **X** |

content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ You can only choose an additional permission if it's not already included in the
8484
- **Set interaction limits**: Temporarily restrict certain users from commenting, opening issues, or creating pull requests in your public repository to enforce a period of limited activity. For more information, see "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)."
8585
- **Set the social preview**: Add an identifying image to your repository that appears on social media platforms when your repository is linked. For more information, see "[Customizing your repository's social media preview](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview)."
8686
- **Push commits to protected branches**: Push to a branch that is marked as a protected branch.
87+
- **Create protected tags**: Create tags that match a tag protection rule. For more information, see "[Configuring tag protection rules](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)."
88+
- **Delete protected tags**: Delete tags that match a tag protection rule. For more information, see "[Configuring tag protection rules](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)."
8789

8890
### Security
8991

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Configuring tag protection rules
3+
shortTitle: Configure tag rules
4+
intro: You can configure tag protection rules for your repository to prevent contributors from creating or deleting tags.
5+
versions:
6+
fpt: '*'
7+
ghes: '>3.4'
8+
ghae: 'issue-6337'
9+
ghec: '*'
10+
---
11+
12+
{% note %}
13+
14+
**Note:** Tag protection rules are currently in beta and subject to change.
15+
16+
{% endnote %}
17+
18+
When you add a tag protection rule, all tags that match the pattern provided will be protected. Only users with admin or maintain permissions in the repository will be able to create protected tags, and only users with admin permissions in the repository will be able to delete protected tags. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#permissions-for-each-role)."
19+
20+
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
21+
22+
{% data reusables.repositories.navigate-to-repo %}
23+
{% data reusables.repositories.sidebar-settings %}
24+
1. In the "Code and automation" section of the sidebar, click **{% octicon "tag" aria-label="The tag icon" %} Tags**.
25+
1. Click **New rule**.
26+
![New tag protection rule](/assets/images/help/repository/new-tag-protection-rule.png)
27+
1. Under "Tag name pattern", type the pattern of the tags you want to protect. In this example, typing "\*" protects all tags.
28+
![Set tag protection pattern](/assets/images/help/repository/set-tag-protection-pattern.png)
29+
1. Click **Add rule**.
30+
![Add tag protection rule](/assets/images/help/repository/add-tag-protection-rule.png)

content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ children:
1717
- /enabling-anonymous-git-read-access-for-a-repository
1818
- /about-email-notifications-for-pushes-to-your-repository
1919
- /configuring-autolinks-to-reference-external-resources
20+
- /configuring-tag-protection-rules
2021
shortTitle: Manage repository settings
2122
---
2223

0 commit comments

Comments
 (0)