Actions393
- Repository Actions
- Repo List Release Attachments
- Repo Create Release Attachment
- Repo Get Release Attachment
- Repo Delete Release Attachment
- Repo Edit Release Attachment
- Repo Get Reviewers
- Repo Signing Key
- Repo List Stargazers
- Repo List Statuses
- Repo Create Status
- Repo List Subscribers
- User Current Check Subscription
- User Current Put Subscription
- User Current Delete Subscription
- Repo List Tag Protection
- Repo Create Tag Protection
- Repo Get Tag Protection
- Repo Delete Tag Protection
- Repo Edit Tag Protection
- Repo List Tags
- Repo Create Tag
- Repo Get Tag
- Repo Delete Tag
- Repo List Teams
- Repo Check Team
- Repo Add Team
- Repo Delete Team
- Repo Tracked Times
- Repo List Topics
- Repo Update Topics
- Repo Add Topic
- Repo Delete Topic
- Repo Transfer
- Accept Repo Transfer
- Reject Repo Transfer
- Repo Create Wiki Page
- Repo Get Wiki Page
- Repo Delete Wiki Page
- Repo Edit Wiki Page
- Repo Get Wiki Pages
- Repo Get Wiki Page Revisions
- Generate Repo
- Repo Get By ID
- Topic Search
- Create Current User Repo
- Repo Migrate
- Repo Search
- Repo Get
- Repo Delete
- Repo Edit
- Repo Get Runner Registration Token
- Repo List Actions Secrets
- Update Repo Secret
- Delete Repo Secret
- List Action Tasks
- Get Repo Variables List
- Get Repo Variable
- Update Repo Variable
- Create Repo Variable
- Delete Repo Variable
- Repo List Activity Feeds
- Repo Get Archive
- Repo Get Assignees
- Repo Update Avatar
- Repo Delete Avatar
- Repo List Branch Protection
- Repo Create Branch Protection
- Repo Update Branch Protection Priories
- Repo Get Branch Protection
- Repo Delete Branch Protection
- Repo Edit Branch Protection
- Repo List Branches
- Repo Create Branch
- Repo Get Branch
- Repo Delete Branch
- Repo Update Branch
- Repo List Collaborators
- Repo Check Collaborator
- Repo Add Collaborator
- Repo Delete Collaborator
- Repo Get Repo Permissions
- Repo Get All Commits
- Repo Get Combined Status By Ref
- Repo List Statuses By Ref
- Repo Get Commit Pull Request
- Repo Compare Diff
- Repo Get Contents List
- Repo Change Files
- Repo Get Contents
- Repo Update File
- Repo Create File
- Repo Delete File
- Repo Apply Diff Patch
- Repo Get Editor Config
- List Forks
- Create Fork
- Get Blob
- Repo Get Single Commit
- Repo Download Commit Diff Or Patch
- Repo Get Note
- Repo List All Git Refs
- Repo List Git Refs
- Get Annotated Tag
- Get Tree
- Repo List Hooks
- Repo Create Hook
- Repo List Git Hooks
- Repo Get Git Hook
- Repo Delete Git Hook
- Repo Edit Git Hook
- Repo Get Hook
- Repo Delete Hook
- Repo Edit Hook
- Repo Test Hook
- Repo Get Issue Config
- Repo Validate Issue Config
- Repo Get Issue Templates
- Repo List Pinned Issues
- Repo List Keys
- Repo Create Key
- Repo Get Key
- Repo Delete Key
- Repo Get Languages
- Repo Get Licenses
- Repo Get Raw File Or LFS
- Repo Merge Upstream
- Repo Mirror Sync
- Repo New Pin Allowed
- Repo List Pull Requests
- Repo Create Pull Request
- Repo List Pinned Pull Requests
- Repo Get Pull Request By Base Head
- Repo Get Pull Request
- Repo Edit Pull Request
- Repo Download Pull Diff Or Patch
- Repo Get Pull Request Commits
- Repo Get Pull Request Files
- Repo Pull Request Is Merged
- Repo Merge Pull Request
- Repo Cancel Scheduled Auto Merge
- Repo Create Pull Review Requests
- Repo Delete Pull Review Requests
- Repo List Pull Reviews
- Repo Create Pull Review
- Repo Get Pull Review
- Repo Submit Pull Review
- Repo Delete Pull Review
- Repo Get Pull Review Comments
- Repo Dismiss Pull Review
- Repo Un Dismiss Pull Review
- Repo Update Pull Request
- Repo List Push Mirrors
- Repo Add Push Mirror
- Repo Push Mirror Sync
- Repo Get Push Mirror By Remote Name
- Repo Delete Push Mirror
- Repo Get Raw File
- Repo List Releases
- Repo Create Release
- Repo Get Latest Release
- Repo Get Release By Tag
- Repo Delete Release By Tag
- Repo Get Release
- Repo Delete Release
- Repo Edit Release
- User Actions
- Update User Secret
- Delete User Secret
- Get User Variables List
- Get User Variable
- Update User Variable
- Create User Variable
- Delete User Variable
- User Get Oauth 2 Application
- User Create O Auth 2 Application
- User Get O Auth 2 Application
- User Delete O Auth 2 Application
- User Update O Auth 2 Application
- User Update Avatar
- User List Blocks
- User Check User Block
- User Block User
- User Unblock User
- User Add Email
- User Delete Email
- User Current List Followers
- User Current List Following
- User Current Check Following
- User Current Put Follow
- User Current Delete Follow
- User Current List GPG Keys
- User Current Post GPG Key
- User Current Get GPG Key
- User Current Delete GPG Key
- User List Hooks
- User Create Hook
- User Get Hook
- User Delete Hook
- User Edit Hook
- User Current List Keys
- User Current Post Key
- User Current Get Key
- User Current Delete Key
- User Current List Repos
- Create Current User Repo
- Update User Settings
- User Current List Starred
- User Current Check Starring
- User Current Put Star
- User Current Delete Star
- User Get Stop Watches
- User Current List Subscriptions
- User List Teams
- User Current Tracked Times
- User Search
- User Get
- User List Activity Feeds
- User List Followers
- User List Following
- User Check Following
- User List GPG Keys
- User Get Heatmap Data
- User List Keys
- User List Repos
- User List Starred
- User List Subscriptions
- User Get Tokens
- User Create Token
- User Delete Access Token
- Activitypub Actions
- Admin Actions
- Admin Cron List
- Admin Cron Run
- Admin Get All Emails
- Admin Search Emails
- Admin List Hooks
- Admin Create Hook
- Admin Get Hook
- Admin Delete Hook
- Admin Edit Hook
- Admin Get All Orgs
- Admin Unadopted List
- Admin Adopt Repository
- Admin Delete Unadopted Repository
- Admin Search Users
- Admin Create User
- Admin Delete User
- Admin Edit User
- Admin List User Badges
- Admin Add User Badges
- Admin Delete User Badges
- Admin Create Public Key
- Admin Delete User Public Key
- Admin Create Org
- Admin Rename User
- Admin Create Repo
- Notification Actions
- Miscellaneous Actions
- Organization Actions
- Org Get All
- Org Create
- Org Get
- Org Delete
- Org Edit
- Org Get Runner Registration Token
- Org List Actions Secrets
- Update Org Secret
- Delete Org Secret
- Get Org Variables List
- Get Org Variable
- Update Org Variable
- Create Org Variable
- Delete Org Variable
- Org List Activity Feeds
- Org Update Avatar
- Org Delete Avatar
- Organization List Blocks
- Organization Check User Block
- Organization Block User
- Organization Unblock User
- Org List Hooks
- Org Create Hook
- Org Get Hook
- Org Delete Hook
- Org Edit Hook
- Org List Labels
- Org Create Label
- Org Get Label
- Org Delete Label
- Org Edit Label
- Org List Members
- Org Is Member
- Org Delete Member
- Org List Public Members
- Org Is Public Member
- Org Publicize Member
- Org Conceal Member
- Org List Repos
- Create Org Repo
- Org List Teams
- Org Create Team
- Team Search
- Org Get Team
- Org Delete Team
- Org Edit Team
- Org List Team Activity Feeds
- Org List Team Members
- Org List Team Member
- Org Add Team Member
- Org Remove Team Member
- Org List Team Repos
- Org List Team Repo
- Org Add Team Repository
- Org Remove Team Repository
- Org List Current User Orgs
- Org List User Orgs
- Org Get User Permissions
- Package Actions
- Issue Actions
- Issue Search Issues
- Issue List Issues
- Issue Create Issue
- Issue Get Repo Comments
- Issue Get Comment
- Issue Delete Comment
- Issue Edit Comment
- Issue List Issue Comment Attachments
- Issue Create Issue Comment Attachment
- Issue Get Issue Comment Attachment
- Issue Delete Issue Comment Attachment
- Issue Edit Issue Comment Attachment
- Issue Get Comment Reactions
- Issue Post Comment Reaction
- Issue Delete Comment Reaction
- Issue Get Issue
- Issue Delete
- Issue Edit Issue
- Issue List Issue Attachments
- Issue Create Issue Attachment
- Issue Get Issue Attachment
- Issue Delete Issue Attachment
- Issue Edit Issue Attachment
- Issue List Blocks
- Issue Create Issue Blocking
- Issue Remove Issue Blocking
- Issue Get Comments
- Issue Create Comment
- Issue Edit Issue Deadline
- Issue List Issue Dependencies
- Issue Create Issue Dependencies
- Issue Remove Issue Dependencies
- Issue Get Labels
- Issue Replace Labels
- Issue Add Label
- Issue Clear Labels
- Issue Remove Label
- Pin Issue
- Unpin Issue
- Move Issue Pin
- Issue Get Issue Reactions
- Issue Post Issue Reaction
- Issue Delete Issue Reaction
- Issue Delete Stop Watch
- Issue Start Stop Watch
- Issue Stop Stop Watch
- Issue Subscriptions
- Issue Check Subscription
- Issue Add Subscription
- Issue Delete Subscription
- Issue Get Comments And Timeline
- Issue Tracked Times
- Issue Add Time
- Issue Reset Time
- Issue Delete Time
- Issue List Labels
- Issue Create Label
- Issue Get Label
- Issue Delete Label
- Issue Edit Label
- Issue Get Milestones List
- Issue Create Milestone
- Issue Get Milestone
- Issue Delete Milestone
- Issue Edit Milestone
Overview
This node operation allows you to edit branch protection settings for a specific repository in Gitea. Branch protection is a critical feature that helps enforce rules and restrictions on branches, ensuring code quality and preventing unauthorized changes. This operation is useful for repository administrators who want to programmatically configure or update branch protection policies such as required approvals, push restrictions, status checks, and more.
Practical examples include:
- Automatically enforcing that certain branches require multiple code review approvals before merging.
- Restricting force pushes or merges to specific teams or users.
- Enabling status checks to ensure CI pipelines pass before allowing merges.
- Managing whitelists for users or teams allowed to push or merge to protected branches.
Properties
| Name | Meaning |
|---|---|
| Owner | The owner of the repository (user or organization). |
| Repo | The name of the repository. |
| Name | The name of the branch to protect. |
| Approvals Whitelist Teams | JSON array of team names allowed to bypass approval requirements. |
| Approvals Whitelist Username | JSON array of usernames allowed to bypass approval requirements. |
| Block Admin Merge Override | Boolean to block administrators from overriding merge restrictions. |
| Block On Official Review Requests | Boolean to block merges if there are official review requests pending. |
| Block On Outdated Branch | Boolean to block merges if the branch is outdated compared to the base branch. |
| Block On Rejected Reviews | Boolean to block merges if there are rejected reviews. |
| Dismiss Stale Approvals | Boolean to automatically dismiss stale pull request approvals when new commits are pushed. |
| Enable Approvals Whitelist | Boolean to enable the approvals whitelist feature. |
| Enable Force Push | Boolean to allow force pushing to the branch. |
| Enable Force Push Allowlist | Boolean to enable a whitelist for force pushing. |
| Enable Merge Whitelist | Boolean to enable a whitelist for merging. |
| Enable Push | Boolean to allow pushing to the branch. |
| Enable Push Whitelist | Boolean to enable a whitelist for pushing. |
| Enable Status Check | Boolean to require status checks before merging. |
| Force Push Allowlist Deploy Keys | Boolean to allow deploy keys to force push. |
| Force Push Allowlist Teams | JSON array of teams allowed to force push. |
| Force Push Allowlist Usernames | JSON array of usernames allowed to force push. |
| Ignore Stale Approvals | Boolean to ignore stale approvals instead of dismissing them. |
| Merge Whitelist Teams | JSON array of teams allowed to merge. |
| Merge Whitelist Usernames | JSON array of usernames allowed to merge. |
| Priority | Numeric priority of the branch protection rule. |
| Protected File Patterns | String pattern(s) specifying files that are protected by this rule. |
| Push Whitelist Deploy Keys | Boolean to allow deploy keys to push. |
| Push Whitelist Teams | JSON array of teams allowed to push. |
| Push Whitelist Usernames | JSON array of usernames allowed to push. |
| Require Signed Commits | Boolean to require commits to be signed. |
| Required Approvals | Number of required approvals before merging. |
| Status Check Contexts | JSON array of status check contexts that must pass before merging. |
| Unprotected File Patterns | String pattern(s) specifying files that are excluded from protection. |
Output
The node outputs JSON data representing the updated branch protection configuration after applying the changes. This typically includes details about the branch protection rules set on the specified branch, such as enabled features, whitelists, required approvals, and other settings.
If the node supports binary data output, it would generally relate to file contents or attachments, but in this case, the output is purely JSON describing branch protection state.
Dependencies
- Requires an API key credential with access rights to the Gitea instance.
- Needs the base URL of the Gitea server configured in credentials.
- The node uses the Gitea REST API v1 endpoints to manage branch protection.
Troubleshooting
- Authentication errors: Ensure the API key credential has sufficient permissions to modify repository settings.
- Invalid repository or branch names: Verify that the "Owner", "Repo", and "Name" fields are correct and exist in the Gitea instance.
- JSON parsing errors: When providing JSON arrays (e.g., whitelists), ensure valid JSON syntax is used.
- Permission denied errors: Confirm that the authenticated user has admin rights on the repository.
- Conflicting settings: Some boolean flags may conflict; review the branch protection policy logic in Gitea documentation if unexpected behavior occurs.