@atomist/sdm-pack-changelog v1.0.3

@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.

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 on our community Slack team at atomist-community.slack.com.

If you find a problem, please create an issue.

Development

You will need to install node to build and test this project.

To run tests, define a GITHUB_TOKEN to any valid token that has repo access. The tests will create and delete repositories.

Define GITHUB_VISIBILITY=public if you want these to be public; default is private. You'll get a 422 response from repo creation if you don't pay for private repos.

Build and Test

Release

To create a new release of the project, update the version in package.json and then push a tag for the version. The version must be of the form M.N.P where M, N, and P are integers that form the next appropriate semantic version for release. The version in the package.json must be the same as the tag. For example:

$ npm version 1.2.3
$ git tag -a -m 'The ABC release' 1.2.3
$ git push origin 1.2.3

The Travis CI build (see badge at the top of this page) will publish the NPM module and automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes.

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