bitbucket-repository-provider

repository provider for bitbucket

API

Table of Contents

• BitbucketBranch
  • entry
    • Parameters
  • entries
    • Parameters
  • commit
    • Parameters
  • attributes
• hash
• BitbucketProvider
  • Parameters
  • repositoryGroupClass
  • repositoryClass
  • branchClass
  • pullRequestClass
  • repositoryBases
  • initializeRepositories
  • name
  • instanceIdentifier
  • attributes
  • areOptionsSufficcient
    • Parameters
• BitbucketPullRequest
  • _merge
    • Parameters
  • list
    • Parameters
  • open
    • Parameters
• BitbucketRepositoryGroup
  • createRepository
    • Parameters
• BitbucketRepository
  • Parameters
  • Properties
  • urls
  • homePageURL
  • issuesURL
  • update
  • createBranch
    • Parameters
  • deleteBranch
    • Parameters

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

• name string

Returns Promise<ContentEntry>

entries

Parameters

• patterns

commit

Commit entries

Parameters

• message string commit message
• updates Array<ContentEntry> content to be commited
• options Object

Returns Promise

attributes

options

hash

Returns string

BitbucketProvider

Extends MultiGroupProvider

Provider for bitbucket repositories.

Supported name schemes are

• https://user:aSecret@bitbucket.org/owner/repo-name.git
• git+https://user:aSecret@bitbucket.org/owner/repo-name.git
• git@bitbucket.org:owner/repo-name.git
• owner/repo-name

Known environment variables

• BITBUCKET_API api
• BB_TOKEN api token
• BITBUCKET_TOKEN api token
• BITBUCKET_USERNAME username
• BITBUCKET_PASSWORD password

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

repositoryGroupClass

Returns Class repository group class used by the Provider

repositoryClass

Returns Class BitbucketRepository

branchClass

Returns Class BitbucketBranch

pullRequestClass

Returns Class pull request class used by the Provider

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

• options Object

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

• method (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 (optional, default {})

  • filter.source Branch?
  • filter.destination Branch?
  • filter.states Set<string>?

Returns Iterator<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

• name string
• options Object

Returns Repository newly created repository

BitbucketRepository

Extends Repository

a repository hosted on bitbucket

Parameters

• owner Owner

• name string

• options Object

  • options.api string?
  • options.group string?

Properties

• api string
• group string
• user string

urls

Returns Array<string> url

homePageURL

Deliver the url of home page.

Returns string '.../overwiew'

issuesURL

Deliver the url of issue tracking system.

Returns string '.../issues'

update

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-put

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

• name string of the new branch to create

• from BitbucketBranch (optional, default this.defaultBranch)

• options Object

  • options.message string

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

• name

install

With npm do:

npm install bitbucket-repository-provider

license

BSD-2-Clause