Atlassian Bitbucket plugin for generating changelog, or releasenotes
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Update lib to 1.88 Jan 15, 2019
.gitignore Update lib to 1.88 Jan 15, 2019
.travis.yml Building for 5.0 May 14, 2017
CHANGELOG.md [maven-release-plugin] prepare for next development iteration Jan 15, 2019
LICENSE license Jan 25, 2019
README.md
changelog.json Creating services and moving stuff around #4 Dec 7, 2015
changelog.mustache Git changelog lib 1.25 Feb 10, 2016
export_and_run.sh Update lib to 1.88 Jan 15, 2019
pom.xml
release.sh
setup-atlassian-sdk.sh Building for 5.0 May 14, 2017

README.md

Git Changelog Bitbucket Plugin Build Status

Generates a changelog, or releasenotes, in Atlassian Bitbucket Server using Git Changelog Lib.

Available in Atlassian Marketplace.

Changelog page

The plugin adds a page on repository level where the user can select from and to branch to generate a changelog.

There are some screenshots here.

REST API

The plugin exposes the changelog as a REST API, available at /bitbucket/rest/changelog/1.0/

/{project}/{repository} - First commit to master
/{project}/{repository}/fromref/{fromRef}/toref/{toRef}
/{project}/{repository}/fromref/{fromRef}/tocommit/{toCommit}
/{project}/{repository}/fromcommit/{fromCommit}/toref/{toRef}
/{project}/{repository}/fromcommit/{fromCommit}/tocommit/{toCommit}

If you have slash / in your branch names, they should be replaced with _slash_. Because Tomcat by default does not allow slashes encoded as %2F.

Variables

The changelog is available in the context of the template. These variables are documented in Git Changelog Lib.

There are also some extended variables available in this Bitbucket plugin.

  • repositoryName Name of repository
  • repositorySlug Name of repository used in URL:s of Bitbucket
  • projectName Name of project
  • projectKey Name of project used in URL:s of Bitbucket
  • jiraUrl URL pointing to Jira, if you have one configured in Bitbucket
  • bitbucketUrl URL pointing at your Bitbucket server

Developer instructions

Prerequisites:

Generate Eclipse project:

atlas-compile eclipse:eclipse

Package the plugin:

atlas-package

Run Bitbucket, with the plugin, on localhost:

export MAVEN_OPTS=-Dplugin.resource.directories=`pwd`/src/main/resources
mvn bitbucket:run

You can also remote debug on port 5005 with:

mvn bitbucket:debug

Make a release (detailed instructions):

  • mvn release:prepare release:perform
  • Browse to GitHub page
  • Upload artifact
  • Write releasenotes
  • Go to Marketplace
  • Create a release