Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conventional-changelog-archived-repos/standard-changelog
deprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo
https://github.com/conventional-changelog-archived-repos/standard-changelog
Last synced: about 2 months ago
JSON representation
deprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo
- Host: GitHub
- URL: https://github.com/conventional-changelog-archived-repos/standard-changelog
- Owner: conventional-changelog-archived-repos
- Archived: true
- Created: 2016-01-30T22:32:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-16T07:55:36.000Z (about 8 years ago)
- Last Synced: 2024-07-26T23:49:56.655Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 15
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Standard CHANGELOG
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coveralls-image]][coveralls-url]
> An opinionated approach to CHANGELOG generation using angular commit conventions.
## Quick Start
```sh
$ npm install -g standard-changelog
$ cd my-project
$ standard-changelog
```
The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
**your first release:**
If you're using this tool for the first time and want to generate new content in CHANGELOG.md, you can run:
```sh
$ standard-changelog --first-release
```
**advanced topics:**
All available command line parameters can be listed using [CLI](#cli) : `standard-changelog --help`.
## Programmatic Usage
```sh
$ npm install --save standard-changelog
```
```js
var standardChangelog = require('standard-changelog');
standardChangelog()
.pipe(process.stdout); // or any writable stream
```
## CLI
```sh
$ npm install -g standard-changelog
$ standard-changelog --help
```
## API
See the [conventional-changelog](https://github.com/ajoslin/conventional-changelog) docs with the angular preset.
## Related
- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) - Generate a changelog from git metadata
- [conventional-github-releaser](https://github.com/conventional-changelog/conventional-github-releaser) - Make a new GitHub release from git metadata
- [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
- [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) - Detect what commit message convention your repository is using
- [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
- [angular-precommit](https://github.com/ajoslin/angular-precommit) - Pre commit with angular conventions
## License
MIT
[npm-image]: https://badge.fury.io/js/standard-changelog.svg
[npm-url]: https://npmjs.org/package/standard-changelog
[travis-image]: https://travis-ci.org/conventional-changelog/standard-changelog.svg?branch=master
[travis-url]: https://travis-ci.org/conventional-changelog/standard-changelog
[daviddm-image]: https://david-dm.org/conventional-changelog/standard-changelog.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/conventional-changelog/standard-changelog
[coveralls-image]: https://coveralls.io/repos/conventional-changelog/standard-changelog/badge.svg
[coveralls-url]: https://coveralls.io/r/conventional-changelog/standard-changelog