https://github.com/coderaiser/changelog-io
Generate ChangeLog
https://github.com/coderaiser/changelog-io
Last synced: about 1 month ago
JSON representation
Generate ChangeLog
- Host: GitHub
- URL: https://github.com/coderaiser/changelog-io
- Owner: coderaiser
- License: mit
- Created: 2014-10-29T16:22:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T20:36:34.000Z (almost 2 years ago)
- Last Synced: 2025-10-11T16:49:36.597Z (6 months ago)
- Language: JavaScript
- Size: 135 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# ChangeLog [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
[NPMIMGURL]: https://img.shields.io/npm/v/changelog-io.svg?style=flat
[BuildStatusURL]: https://github.com/coderaiser/changelog-io/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/changelog-io/workflows/Node%20CI/badge.svg
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/changelog-io "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/coderaiser/changelog-io?branch=master
[CoverageIMGURL]: https://coveralls.io/repos/coderaiser/changelog-io/badge.svg?branch=master&service=github
Generate changelog with one command.
## Install
```
npm i changelog-io -g
```
## How it works?
If you already have tags and use conventions like this:
- `feature(scope) command message`;
- `fix(scope) commit message`;
- `docs(scope) commit message`;
- `chore(scope) commit message`;
- `refactor(scope) commit message`;
Or:
- `feature: scope: command message`;
- `fix: scope: commit message`;
- `docs: scope: commit message`;
- `chore: scope: commit message`;
- `refactor: scope: commit message`;
`feature` and `fix` commit messages from previous tag will print out to screen.
## How to use?
```
changelog # to log output
changelog version > ChangeLog # to save output to ChangeLog
```
## API
```js
import {changelog} from 'changelog-io';
changelog('v1.0.0');
// returns
`
2021.08.25
feature:
- a1d0d14 (package) eslint-plugin-putout v9.2.1
- a1d0d15 (package) putout v19.0.0
- a1d0d16 (changelog) convert ot ESM
`;
```
## License
MIT