@atomist/sdm-pack-changelog v1.0.0-master.20180827183213

@atomist/sdm-pack-changelog

Extension Pack for an Atomist SDM to manage changelogs as per Keep a Changelog.

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.

See the Atomist documentation for more information on what SDMs are and what they can do for you using the Atomist API for software.

Usage

1. First install the dependency in your SDM project

$ npm install @atomist/sdm-pack-changelog

2. Install the support

import { changelogSupport } from "@atomist/sdm-pack-changelog";

sdm.addExtensionPacks(
    changelogSupport()
);

3. Add configuration to your client configuration

// no configuration needed

Support

General support questions should be discussed in the #support channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Development

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

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. Just press the 'Approve' button in the Atomist dashboard or Slack.

Created by Atomist. Need Help? Join our Slack workspace.