JSPM – conventional-changelog-angular-bitbucket-jira@1.0.3

Package Exports

conventional-changelog-angular-bitbucket-jira

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (conventional-changelog-angular-bitbucket-jira) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

conventional-changelog Angular preset for BitBucket repositories

See convention.

Issues with the convention itself should be reported on the angular issue tracker.

Why does this exist?

The conventional-changelog-angular preset assumes that the repository is hosted on GitHub, but it will still work (with limited functionality) for non-GitHub repositories.

This preset aims to produce a changelog that contains the correct formatting and links for BitBucket.

Differences to conventional-changelog-angular

Issue links are highlighted automatically by BitBucket. But if there is a bugs URL in package.json, then issue links WILL be generated.
@-mentions are highlighted automatically by BitBucket
Commit links use a different format
Comparison links (between two versions) use a different format

Install

npm install conventional-changelog-angular-bitbucket --save-dev

Usage

Install the package in the project which will use it.
Set the preset to angular-bitbucket:

const changelog = require('conventional-changelog');
changelog({preset: 'angular-bitbucket'});

Usage with `corp-semantic-release`

{
  "repository": {
    "type": "git",
    "url": "https://bitbucket.host.com/org/repo.git"
  },
  "bugs": {
    "url": "https://some.url/issues"
  },
  "scripts": {
    "semantic-release": "corp-semantic-release --changelogpreset angular-bitbucket"
  },
  "devDependencies": {
    "conventional-changelog-angular-bitbucket": "*",
    "corp-semantic-release": "6.2.0"
  }
}

Contributing

See CONTRIBUTING.md.

License

This software is licensed under the MIT Licence. See LICENSE.

Thanks

Thanks to stevemao who wrote conventional-changelog-angular.

conventional-changelog-angular-bitbucket-jira