# @atomist/sdm-pack-changelog

> Extension Pack for an Atomist SDM to manage changelogs

Latest version **1.0.3** (published 2019-10-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @atomist/sdm-pack-changelog
pnpm add @atomist/sdm-pack-changelog
yarn add @atomist/sdm-pack-changelog
bun add @atomist/sdm-pack-changelog
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-10-04 |
| First published | 2018-07-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.2.0 |
| Dependencies | 13 |
| Unpacked size | 855 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Atomist |
| Maintainers | atomist |
| Keywords | atomist, automation, sdm, extension, pack, changelog |

## Links

- npm: https://www.npmjs.com/package/@atomist/sdm-pack-changelog
- Repository: https://github.com/atomist/sdm-pack-changelog
- Homepage: https://github.com/atomist/sdm-pack-changelog#readme
- Issues: https://github.com/atomist/sdm-pack-changelog/issues
- npm.io page: https://npm.io/package/@atomist/sdm-pack-changelog

## Dependencies (13)

- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [remark](https://npm.io/package/remark.md) ^10.0.1
- [semver](https://npm.io/package/semver.md) ^5.6.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^16.1.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.141
- [@types/semver](https://npm.io/package/@types/semver.md) ^5.5.0
- [license-checker](https://npm.io/package/license-checker.md) ^25.0.1
- [remark-defsplit](https://npm.io/package/remark-defsplit.md) ^1.3.1
- [changelog-parser](https://npm.io/package/changelog-parser.md) ^2.7.0
- [remark-inline-links](https://npm.io/package/remark-inline-links.md) ^3.1.2
- [remark-reference-links](https://npm.io/package/remark-reference-links.md) ^4.0.3
- [@atomist/slack-messages](https://npm.io/package/@atomist/slack-messages.md) ^1.1.1

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-10-04
- 1.0.4-master.20191010120908 (branch-master) — 2019-10-10
- 1.0.0-atomist-update-next-1535368891264.20180827112137 (branch-atomist-update-next-1535368891264) — 2018-08-27
- 0.1.1-unreleased-tree-1.20180716163708 (branch-unreleased-tree-1) — 2018-07-16
- 1.0.3-master.20191004170440 — 2019-10-04
- 1.0.3-master.20191004165758 — 2019-10-04
- 1.0.3-master.20191004165455 — 2019-10-04
- 1.0.3-master.20190916032329 — 2019-09-16
- 1.0.3-atomist.a260p86nh.typescript-version.master.20190915212834 — 2019-09-15
- 1.0.3-master.20190910082305 — 2019-09-10
- 1.0.3-atomist.a260p86nh.sdm-deps.master.20190909203510 — 2019-09-09
- 1.0.3-master.20190709171731 — 2019-07-09
- 1.0.3-atomist-update-latest-20190709164121.20190709165505 — 2019-07-09
- 1.0.3-master.20190708201110 — 2019-07-08
- 1.0.3-atomist-update-latest-20190708195248.20190708195558 — 2019-07-08
- … 91 more at https://npm.io/package/@atomist/sdm-pack-changelog/versions

## README

<p align="center">
  <img src="https://images.atomist.com/sdm/SDM-Logo-Dark.png">
</p>

# @atomist/sdm-pack-changelog

[![atomist sdm goals](http://badge.atomist.com/T29E48P34/atomist/sdm-pack-changelog/357b4015-f10d-4ebd-a825-0d033c1e75bd)](https://app.atomist.com/workspace/T29E48P34)
[![npm version](https://img.shields.io/npm/v/@atomist/sdm-pack-changelog.svg)](https://www.npmjs.com/package/@atomist/sdm-pack-changelog)

Extension Pack for an Atomist SDM to manage changelogs as per [Keep a
Changelog](http://keepachangelog.com/).

This extension pack lets you install the issue and pull request labels
via `@atomist add changelog labels`.  When those labels (changelog:*
prefix) are assigned to issues and/or pull requests, those issues and
pull requests will be added to the `CHANGELOG.md` once they get
closed.

Additionally this pack also provides a `releaseChangelogGoal()` method
to create a goal that can get added to your SDM. This goal will
convert the `Unreleased` section of the `CHANGELOG.md` to a versioned
section.

Software delivery machines enable you to control your delivery process
in code.  Think of it as an API for your software delivery.  See the
[Atomist documentation][atomist-doc] for more information on the
concept of a software delivery machine and how to create and develop
an SDM.

[atomist-doc]: https://docs.atomist.com/ (Atomist Documentation)

## Getting started

See the [Developer Quick Start][atomist-quick] to jump straight to
creating an SDM.

[atomist-quick]: https://docs.atomist.com/quick-start/ (Atomist - Developer Quick Start)

## Contributing

Contributions to this project from community members are encouraged
and appreciated. Please review the [Contributing
Guidelines](CONTRIBUTING.md) for more information. Also see the
[Development](#development) section in this document.

## Code of conduct

This project is governed by the [Code of
Conduct](CODE_OF_CONDUCT.md). You are expected to act in accordance
with this code by participating. Please report any unacceptable
behavior to code-of-conduct@atomist.com.

## Documentation

Please see [docs.atomist.com][atomist-doc] for
[developer][atomist-doc-sdm] documentation.

[atomist-doc-sdm]: https://docs.atomist.com/developer/sdm/ (Atomist Documentation - SDM Developer)

## Connect

Follow [@atomist][atomist-twitter] and [The Composition][atomist-blog]
blog related to SDM.

[atomist-twitter]: https://twitter.com/atomist (Atomist on Twitter)
[atomist-blog]: https://the-composition.com/ (The Composition - The Official Atomist Blog)

## Support

General support questions should be discussed in the `#support`
channel in the [Atomist community Slack workspace][slack].

If you find a problem, please create an [issue][].

[issue]: https://github.com/atomist/sdm-pack-change-log/issues

## Development

You will need to install [Node.js][node] to build and test this project.

[node]: https://nodejs.org/ (Node.js)

### Build and test

Install dependencies.

```
$ npm install
```

Use the `build` package script to compile, test, lint, and build the
documentation.

```
$ npm run build
```

### Release

Releases are handled via the [Atomist SDM][atomist-sdm].  Just press
the 'Approve' button in the Atomist dashboard or Slack.

[atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine)

---

Created by [Atomist][atomist].
Need Help?  [Join our Slack workspace][slack].

[atomist]: https://atomist.com/ (Atomist - How Teams Deliver Software)
[slack]: https://join.atomist.com/ (Atomist Community Slack)

---
_Source: https://npm.io/package/@atomist/sdm-pack-changelog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
