Readme.md

@iteratec/semantic-release-bitbucket

a semantic-release plugin to publish releases to Bitbucket.

verifyConditions

verifies that environment variables for authentication via username and password are set. It uses the Bitbucket Url from the config or defaults to Bitbucket Cloud. It uses the teamName and repositoryName settings to compose the url and attempts to login.

publish

creates a tag using the new version generated by sematic-release. At the time of writing Bitbucket does not support messages with tags, so the release notes are currently not published.

Configuration

Bitbucket authentication

The authentication parameters for Bitbucket are required and can be set via environment variables. Consider using an app password instead of your account password. See App passwords in the Bitbucket documentation for further information.

Environment variables

Variable	Description
BITBUCKET_USER	The username as given in the profile of repository owner. This can be your user or a team account.
BITBUCKET_PASSWORD	The (app) password for the given user.

Options

Option	Description
bitbucketUrl	Optional. The url of the bitbucket server REST api. Defaults to Bitbucket Cloud.
repositoryName	Required. The name of the repository to publish to
teamName	Optional. Is used as the repository owner portion in the url. BITBUCKET_USER is used as default if no teamName is given.

Usage

full configuration:

{
  "verifyConfig": [..., "@iteratec/semantic-release-bitbucket", ...],
  "publish": [
    ...,
    {
      "path": "@iteratec/semantic-release-bitbucket",
      "bitbucketUrl": "http://my.bitbucket.server",
      "teamName": "A-Team",
      "repositoryName": "bucket"
    },
    ...
  ]
}

minimum configuration:

{
  "verifyConfig": [..., "@iteratec/semantic-release-bitbucket", ...],
  "publish": [
    ...,
    {
      "path": "@iteratec/semantic-release-bitbucket",
      "repositoryName": "bucket"
    },
    ...
  ]
}