📓
Bitbucket changelog generator

A changelog generator for bitbucket, using the merged pull requests and template

Examples

npm i bitbucket-changelog-generator

Table of Contents

• Installation
• How to use
• Environment variables
• Default template
• Overwrite the default configuration
• How to do it

Installation

pnpm install bitbucket-changelog-generator

or

npm install bitbucket-changelog-generator

How to use

export <REQUIRED_ENV> 
bitbucket-changelog

Environment variables

Name	Description	Required
BITBUCKET_USERNAME*	Username to connect via API	Yes
BITBUCKET_APP_PASSWORD*	APP password to connect via API	Yes
BITBUCKET_WORKSPACE	Workspace from which to obtain pull request	Yes
BITBUCKET_REPO_SLUG	slug of the repository from which to obtain the pull request	Yes
CHANGELOG_CONFIG_PATH	Path of the json file if you want to modify the configuration	No

* It is necessary to create an APP password with pull request reading permissions.

Default template

Bitbucket changelog has a default template that is used if you do not overwrite it. You can see the template code here: template.md

Overwrite the default configuration

You can overwrite the configuration to overwrite:

• the default template
• the title
• sections
• etc

How to do it

1. Create a .json file.
2. Define the environment var CHANGELOG_CONFIG_PATH with the path to the json file that overwrites the configuration.
3. Define the custom configuration, the options are:

{
  "title": "Changelog",   // Title of the changelog.
  "outputPath": "CHANGELOG.md",   // Changelog file path.
  "templatePath": "template.md",    // Custom template path.
  "fields": [   // Query fields from which to obtain data (see https://developer.atlassian.com/cloud/bitbucket/rest/intro/#querying)
    "size", 
    "values.id", 
    "values.title", 
    "values.created_on", 
    "values.links.html.href"
  ],
  "sections": [   // Sections in which to separate the log.
    {
      "slug": "feature",    // Key that can be used in the template.
      "title": "Feature",   // Section title.
      "branchFilter": "feature/"    // Filter applied on branch names (case-insensitive text contains).
    },
    {
      "slug": "bugfix",
      "title": "Bugfix",
      "branchFilter": "bugfix/"
    }
  ]
}