bitbucket-repository-provider
repository provider for bitbucket
API
Table of Contents
BitbucketBranch
Extends Branch
Branch of a bitbucket repository.
entry
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/src/%7Bnode%7D/%7Bpath%7D
Parameters
Returns Promise<ContentEntry>
entries
Parameters
commit
Commit entries
Parameters
message
string commit messageupdates
Array<ContentEntry> content to be commitedoptions
Object?
Returns Promise
attributes
options
hash
Returns string
BitbucketHook
Extends Hook
BitbucketProvider
Extends MultiGroupProvider
Provider for bitbucket repositories.
Supported name schemes are
Parameters
-
config
Object
-
config.url
string provider scm base
-
config.api
string provider api base
-
config.authentication
Object authentication
config.authentication.type
string config.authentication.username
string config.authentication.password
string
repositoryBases
All possible base urls.
Returns Array<string> common base urls of all repositories
initializeRepositories
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories
name
We are called bitbucket.
Returns string bitbucket
instanceIdentifier
Default instance env name prefix.
attributes
Default configuration as given for the cloud privider.
Returns Object
areOptionsSufficcient
Parameters
Returns boolean true if authentication is present
BitbucketPullRequest
Extends PullRequest
Pull request inside bitbucket
_merge
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/pullrequests/%7Bpull_request_id%7D/merge
Parameters
merge_strategy
(optional, default "merge_commit"
)
list
List all pull request for a given repo.
Result will be filtered by source branch, destination branch and states
Parameters
-
repository
Repository
-
filter
Object?
filter.source
Branch? filter.destination
Branch? filter.states
Set<string>?
Returns AsyncIterable<PullRequest>
open
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/pullrequests#post
Parameters
source
destination
options
BitbucketRepositoryGroup
Extends RepositoryGroup
createRepository
https://community.atlassian.com/t5/Bitbucket-articles/Create-and-configure-a-Bitbucket-Server-repository-using-the/ba-p/828364
Parameters
Returns Promise<Repository> newly created repository
BitbucketRepository
Extends Repository
a repository hosted on bitbucket
Parameters
Properties
homePageURL
Deliver the url of home page.
Returns string '.../overwiew'
issuesURL
Deliver the url of issue tracking system.
Returns string '.../issues'
update
initializeHooks
initializeBranches
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-refs/#api-group-refs
createBranch
Create a new branch
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches?_ga=2.65542446.1034690805.1541022941-164225451.1541022941#post
Parameters
deleteBranch
https://docs.atlassian.com/bitbucket-server/rest/5.8.0/bitbucket-branch-rest.html#idm45555984542992
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches/%7Bname%7D#delete
Parameters
install
With npm do:
npm install bitbucket-repository-provider
license
BSD-2-Clause