Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Div
idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Description

Bitbucket 4.x completely changed the branch permission model that previously existed with Stash. While Bitbucket still refers to the concept as Branch Permissions, the documentation actually indicates that the new model is really a branch restriction model - "... are actually restrictions, which are checked after project and repository level permissions". And, in fact, the model is restrictions with exceptions by groups or users. Keyed by restriction and matching type, different restrictions can be added.

We have decided that the CLI needs to reflect the terminology of the new model and discard the older terminology in order to avoid confusion in the future. While it is understandable that Atlassian has chosen to keep the older terminology at least for now to reduce the impact of the change on documentation and because the UI can mask the confusing points, we feel the same is not true for CLI action names and terminology. 

...

Tip

Affective with CLI 5.6 and above.

Until finally released, refer to the SNAPSHOT documentation

Removed Actions

  • grantBranchPermissions

  • updateBranchPermissions

  • revokeBranchPermissions

  • getBranchPermissionList

New Actions

  • addBranchRestriction
  • removeBranchRestriction
  • getBranchRestrictionList

Removed Actions

  • grantBranchPermissions

  • updateBranchPermissions

  • revokeBranchPermissions

  • getBranchPermissionList

New Actions

  • addBranchRestriction
  • removeBranchRestriction
  • getBranchRestrictionList

Related Parameters

Table plus
ParameterDefaultDescription
restrictionread-only

Branch restriction. Defaults to read-only. Restrictions are:

Div
Restriction (CLI)UI Description
read-onlyPrevent all changes
no-deletesPrevent deletion
fast-forward-onlyPrevent re-writing history
pull-request-onlyPrevent changes without a pull request
matchingTypeBRANCH

Branch matching type. Defaults to BRANCH. Determines usage of branch parameter value. Types are:

branch

For branch permissions, it can represent a branch, branch pattern, or branching model. Examples:

  • master (BRANCH)
  • xyz* (PATTERN)
  • feature/ (MODEL)

group
A comma separated list of group names. Groups are exceptions to the restriction.
userId
A comma separated list of user ids. Users are exceptions to the restriction.

Discontinued Stash Support

With CLI 5.6, we are no longer supporting Stash 3.x. We didn't want to confuse the branch permission issue further by trying to support both models at the same time.