Skip to content

AndresRodH/changesets-changelog-bitbucket

Repository files navigation

changesets-changelog-bitbucket

npm version

Generate changelogs from bitbucket repositories. Mimics what @changesets/changelog-github does but for Bitbucket repositories.

Motivation

We use Bitbucket at our company and use standard-version. In my opinion and what we've experienced using standard-version, I concluded it did not fit our team's necessities. Due to lack of tooling in Bitbucket, it is pretty difficult to keep the conventional commits structure since there is no easy way to add a build check for the merge commit or adding a plugin to format it for you. Manually fixing or adding changelog entries is something we should not be doing and rather focus on deliverables.

I like how @changesets/changelog-github formats the changelog entries and wanted to have the same functionality for our project. I tried to look for a package that offers this but there was not one available at the moment, so I decided to roll one by mimicking what the official one does for Github.

Instalation

# for yarn users
yarn add -D changesets-changelog-bitbucket

# for npm users
npm install --save-dev changesets-changelog-bitbucket

Configuration

In your .changeset/config.json file:

{
  "changelog": [
    "changesets-changelog-bitbucket",
    {"repo": "atlassian/atlaskit"}
  ]
}

Add a .env file with BITBUCKET_USERNAME and BITBUCKET_PASSWORD

BITBUCKET_USERNAME=username
BITBUCKET_PASSWORD=password