npm package: @interaktiv/conventional-changelog-dia-bitbucket
Description: Conventional Changelog Preset for Bitbucket Repos at DIA
Author: DIA die.interaktiven GmbH & Co. KG
Latest version: 1.0.1

# conventional-changelog-dia-bitbucket

<div style="background-color: #FFF8DC; padding: 1rem; border-left: 2px solid #ffeb8e;">
  <strong>DEPRECATED in favor of <a href="https://npmjs.com/package/@interaktiv/conventional-changelog-dia">@interaktiv/conventional-changelog-dia</a></strong>
</div><br />

> [Conventional Changelog][] Preset used for [Bitbucket][] Repos at
> [DIA][dia-website]

[![Commitizen friendly][commitizen-badge]][commitizen]
[![semantic-release][semantic-release-badge]][semantic-release]
[![MIT License][license-badge]][license] [![version][version-badge]][package]

[![npm latest version][latest-version-badge]][package]
[![npm next version][next-version-badge]][package]

**Issues with the convention itself should be reported on the [angular issue
tracker][conventional-changelog-angular].**

## Background

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 change log that contains the correct formatting
and links for BitBucket too.

It detects which git hosting provider is used and handles the templates etc.
accordingly.

### Differences to [conventional-changelog-angular][]

- Issue links are highlighted automatically by BitBucket e.g. #12345. But if
  there is a JIRA ticket reference like #EXM-123, then JIRA links will be
  generated

  > Currently the JIRA host is statically defined in code

- `@`-mentions are highlighted automatically by BitBucket
- Commit links use a different format
- Comparison links (between two versions) use a different format

## Prerequisites

- [semantic-release/release-notes-generator][] plugin version `>= 6.0.0`

## Installation

```shell
npm install --save-dev @interaktiv/conventional-changelog-dia-bitbucket
```

## Usage

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

```javascript
const changelog = require('conventional-changelog');
changelog({ preset: 'dia-bitbucket' });
```

## Usage with `semantic-release`

`.releaserc.js`:

```javascript
module.exports = {
  branch: 'master',
  plugins: [
    '@semantic-release/commit-analyzer',
    [
      '@semantic-release/release-notes-generator',
      {
        preset: 'dia-bitbucket',
      },
    ],
    '@semantic-release/changelog',
    '@semantic-release/npm',
    '@semantic-release/git',
  ],
};
```

### 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 dia-bitbucket"
  },
  "devDependencies": {
    "conventional-changelog-dia-bitbucket": "*",
    "corp-semantic-release": "6.2.0"
  }
}
```

## Contributing

See [CONTRIBUTING.md][].

## Acknowledgments

Thanks to [stevemao][] who wrote [conventional-changelog-angular][].

Also special thanks to [uglow][] who wrote
[conventional-changelog-angular-bitbucket][] that has served as a base for this
one.

## License

[MIT][license] Copyright © 2019-present [die.interaktiven GmbH & Co.
KG][dia-website]

[bitbucket]: https://bitbucket.org
[commitizen]: http://commitizen.github.io/cz-cli
[commitizen-badge]:
  https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[contributing.md]: ./CONTRIBUTING.md
[conventional changelog]:
  https://github.com/conventional-changelog/conventional-changelog
[conventional-changelog-angular]:
  https://github.com/conventional-changelog/conventional-changelog
[conventional-changelog-angular-bitbucket]:
  https://github.com/uglow/conventional-changelog-angular-bitbucket
[dia-website]: https://die-interaktiven.de
[downloads-badge]:
  https://img.shields.io/npm/dw/@interaktiv/conventional-changelog-dia-bitbucket.svg
[downloads-total-badge]:
  https://img.shields.io/npm/dt/@interaktiv/conventional-changelog-dia-bitbucket.svg
[latest-version-badge]:
  https://img.shields.io/npm/v/@interaktiv/conventional-changelog-dia-bitbucket/latest.svg
[license]: https://opensource.org/licenses/MIT
[license-badge]:
  https://img.shields.io/npm/l/@interaktiv/conventional-changelog-dia-bitbucket.svg
[next-version-badge]:
  https://img.shields.io/npm/v/@interaktiv/conventional-changelog-dia-bitbucket/next.svg
[package]:
  https://npmjs.com/package/@interaktiv/conventional-changelog-dia-bitbucket
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]:
  https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release/release-notes-generator]:
  https://github.com/semantic-release/release-notes-generator
[stevemao]: https://github.com/stevemao
[uglow]: https://github.com/uglow
[version-badge]:
  https://img.shields.io/npm/v/@interaktiv/conventional-changelog-dia-bitbucket.svg