https://github.com/uglow/conventional-changelog-angular-bitbucket

Angular conventional-changelog preset for BitBucket repositories
https://github.com/uglow/conventional-changelog-angular-bitbucket

Last synced: 4 months ago
JSON representation

Angular conventional-changelog preset for BitBucket repositories

• Host: GitHub
• URL: https://github.com/uglow/conventional-changelog-angular-bitbucket
• Owner: uglow
• License: other
• Created: 2017-01-10T10:28:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T12:24:35.000Z (over 3 years ago)
• Last Synced: 2025-07-05T17:45:04.619Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 963 KB
• Stars: 12
• Watchers: 0
• Forks: 12
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> [conventional-changelog](https://github.com/ajoslin/conventional-changelog) [Angular](https://github.com/angular/angular) preset for BitBucket repositories

See [convention](convention.md).

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

[![NPM Version](https://img.shields.io/npm/v/conventional-changelog-angular-bitbucket.svg?style=flat-square)](http://npm.im/conventional-changelog-angular-bitbucket)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Coverage Status](https://coveralls.io/repos/github/uglow/conventional-changelog-angular-bitbucket/badge.svg?branch=master)](https://coveralls.io/github/uglow/conventional-changelog-angular-bitbucket?branch=master)

[![Dependencies status](https://david-dm.org/uglow/conventional-changelog-angular-bitbucket/status.svg?theme=shields.io)](https://david-dm.org/uglow/conventional-changelog-angular-bitbucket#info=dependencies)

[![Dev-dependencies status](https://david-dm.org/uglow/conventional-changelog-angular-bitbucket/dev-status.svg?theme=shields.io)](https://david-dm.org/uglow/conventional-changelog-angular-bitbucket#info=devDependencies)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Why does this exist?

The [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog) 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](https://github.com/conventional-changelog/conventional-changelog)

- 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

1. Install the package in the project which will use it.

2. Set the preset to `angular-bitbucket`:

```

const changelog = require('conventional-changelog');

changelog({preset: 'angular-bitbucket'});

```

### Usage with `corp-semantic-release`

```json

{

  "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](CONTRIBUTING.md).

## License

This software is licensed under the MIT Licence. See [LICENSE](LICENSE).

## Thanks

Thanks to [stevemao](https://github.com/stevemao) who wrote [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog).