@atomist/sdm-pack-changelog
Version:
Extension Pack for an Atomist SDM to manage changelogs
112 lines (73 loc) • 3.54 kB
Markdown
<p align="center">
<img src="https://images.atomist.com/sdm/SDM-Logo-Dark.png">
</p>
# @atomist/sdm-pack-changelog
[](https://app.atomist.com/workspace/T29E48P34)
[](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)