Skip to content

@indiekit/store-bitbucket

Bitbucket content store adaptor for Indiekit.

Installation

npm install @indiekit/store-bitbucket

Requirements

A Bitbucket API token with read:repository:bitbucket and write:repository:bitbucket scopes.

IMPORTANT

Store your app password in an environment variable called BITBUCKET_TOKEN so that only you and the application can see it.

Usage

Add @indiekit/store-bitbucket to your list of plug-ins, specifying options as required:

json
{
  "plugins": ["@indiekit/store-bitbucket"],
  "@indiekit/store-bitbucket": {
    "email": "username@website.example",
    "user": "username",
    "repo": "reponame"
  }
}

Options

OptionTypeDescription
emailstringYour Atlassian email. Required.
userstringYour Bitbucket workspace. Required.
repostringThe name of your Bitbucket repository. Required.
branchstringThe branch files will be saved to. Optional, defaults to main.
tokenstringA Bitbucket API token. Required, defaults to process.env.BITBUCKET_TOKEN.