https://github.com/arlac77/bitbucket-repository-provider

repository provider for bitbucket
https://github.com/arlac77/bitbucket-repository-provider
bitbucket
Last synced: 2 months ago
JSON representation
repository provider for bitbucket
Host: GitHub
URL: https://github.com/arlac77/bitbucket-repository-provider
Owner: arlac77
License: 0bsd
Created: 2017-11-16T17:01:41.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2026-03-27T17:49:34.000Z (3 months ago)
Last Synced: 2026-03-28T01:48:52.704Z (3 months ago)
Topics: bitbucket
Language: JavaScript
Homepage:
Size: 4.24 MB
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          [![npm](https://img.shields.io/npm/v/bitbucket-repository-provider.svg)](https://www.npmjs.com/package/bitbucket-repository-provider)

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)

[![bundlejs](https://deno.bundlejs.com/?q=bitbucket-repository-provider\&badge=detailed)](https://bundlejs.com/?q=bitbucket-repository-provider)

[![downloads](http://img.shields.io/npm/dm/bitbucket-repository-provider.svg?style=flat-square)](https://npmjs.org/package/bitbucket-repository-provider)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/bitbucket-repository-provider.svg?style=flat-square)](https://github.com/arlac77/bitbucket-repository-provider/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fbitbucket-repository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/bitbucket-repository-provider/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/bitbucket-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/bitbucket-repository-provider)

# bitbucket-repository-provider

repository provider for bitbucket

# API

### Table of Contents

*   [BitbucketBranch](#bitbucketbranch)

    *   [entry](#entry)

        *   [Parameters](#parameters)

    *   [entries](#entries)

        *   [Parameters](#parameters-1)

    *   [commit](#commit)

        *   [Parameters](#parameters-2)

    *   [attributes](#attributes)

*   [hash](#hash)

*   [BitbucketHook](#bitbuckethook)

*   [BitbucketProvider](#bitbucketprovider)

    *   [Parameters](#parameters-3)

    *   [repositoryBases](#repositorybases)

    *   [initializeRepositories](#initializerepositories)

    *   [name](#name)

    *   [instanceIdentifier](#instanceidentifier)

    *   [attributes](#attributes-1)

*   [BitbucketPullRequest](#bitbucketpullrequest)

    *   [\_merge](#_merge)

        *   [Parameters](#parameters-4)

    *   [list](#list)

        *   [Parameters](#parameters-5)

    *   [open](#open)

        *   [Parameters](#parameters-6)

*   [BitbucketRepositoryGroup](#bitbucketrepositorygroup)

    *   [createRepository](#createrepository)

        *   [Parameters](#parameters-7)

*   [BitbucketRepository](#bitbucketrepository)

    *   [Parameters](#parameters-8)

    *   [Properties](#properties)

    *   [homePageURL](#homepageurl)

    *   [issuesURL](#issuesurl)

    *   [update](#update)

    *   [initializeHooks](#initializehooks)

    *   [initializeBranches](#initializebranches)

    *   [createBranch](#createbranch)

        *   [Parameters](#parameters-9)

    *   [deleteBranch](#deletebranch)

        *   [Parameters](#parameters-10)

## BitbucketBranch

**Extends Branch**

Branch of a bitbucket repository.

### entry

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\** 

### entries

#### Parameters

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 

### commit

Commit entries

#### Parameters

*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message

*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** content to be commited

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** 

### attributes

options

## hash

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

## BitbucketHook

**Extends Hook**

## BitbucketProvider

**Extends MultiGroupProvider**

Provider for bitbucket repositories.

Supported name schemes are

*   

*   git+

*   :owner/repo-name.git

*   owner/repo-name

    Known environment variables

*   BITBUCKET\_API api

*   BITBUCKET\_TOKEN api token

*   BITBUCKET\_USERNAME username

*   BITBUCKET\_APP\_PASSWORD password

*   BITBUCKET\_PASSWORD password

### Parameters

*   `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

    *   `config.url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider scm base

    *   `config.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider api base

    *   `config.authentication` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** authentication

        *   `config.authentication.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

        *   `config.authentication.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

        *   `config.authentication.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

### repositoryBases

All possible base urls.

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** common base urls of all repositories

### initializeRepositories

### name

We are called bitbucket.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** bitbucket

### instanceIdentifier

Default instance env name prefix.

### attributes

Default configuration as given for the cloud privider.

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

## BitbucketPullRequest

**Extends PullRequest**

Pull request inside bitbucket

### \_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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 

    *   `filter.source` **Branch?** 

    *   `filter.destination` **Branch?** 

    *   `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?** 

Returns **AsyncIterable\** 

### open

#### Parameters

*   `source`  

*   `destination`  

*   `options`  

## BitbucketRepositoryGroup

**Extends RepositoryGroup**

### createRepository

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\** newly created repository

## BitbucketRepository

**Extends Repository**

a repository hosted on bitbucket

### Parameters

*   `owner` **RepositoryOwner** 

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

    *   `options.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 

    *   `options.group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 

### Properties

*   `api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

*   `user` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

### homePageURL

Deliver the url of home page.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** '.../overwiew'

### issuesURL

Deliver the url of issue tracking system.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** '.../issues'

### update

*   **See**: 

### initializeHooks

*   **See**: 

### initializeBranches

### createBranch

Create a new branch

#### Parameters

*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch to create

*   `from` **[BitbucketBranch](#bitbucketbranch)**  (optional, default `this.defaultBranch`)

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

    *   `options.message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 

### deleteBranch

#### Parameters

*   `name`  

# install

With [npm](http://npmjs.org) do:

```shell

npm install bitbucket-repository-provider

```

# license

BSD-2-Clause
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/arlac77/bitbucket-repository-provider

Awesome Lists containing this project

README
