https://github.com/nexenio/strangelog

Painless file-based changelog management via CLI.
https://github.com/nexenio/strangelog

changelog node npm versioning

Last synced: about 1 month ago
JSON representation

Painless file-based changelog management via CLI.

• Host: GitHub
• URL: https://github.com/nexenio/strangelog
• Owner: neXenio
• Created: 2017-06-26T14:01:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-14T08:45:06.000Z (about 7 years ago)
• Last Synced: 2023-12-23T04:02:29.090Z (about 1 year ago)
• Topics: changelog, node, npm, versioning
• Language: JavaScript
• Size: 142 KB
• Stars: 14
• Watchers: 22
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# strangelog

[![Build Status](https://travis-ci.org/neXenio/strangelog.svg?branch=master)](https://travis-ci.org/neXenio/strangelog)

Manage your changelog via CLI – painless, merge-conflict free, CI-friendly.

## Getting Started

For yarn users: `yarn add --dev strangelog`

For npm users: `npm install --save-dev strangelog`

Done.

## Usage

Once installed, the strangelog command is available via `yarn run strangelog [command]` or `npm run strangelog [command]`.

### `strangelog add`

Documents a new change. For that, you will be prompted for the following information:

- the component your change refers to (if multiple `components` are defined `.strangelogrc`)

- the kind of change you did (addition, change or bug fix)

- a free text description

**Example:** `yarn run strangelog add`

**Note:** This adds each entry as a single file into directory called `next` inside of your changelog path. These, you need to commit to actually maintain a project changelog.

### `strangelog bump`

Takes all the entries in the `next` directory and moves them to a new version directory (e.g. `1.2.3`). It will ask you what the next version should be.

**Example:** `yarn run strangelog bump`

### `strangelog generate`

Takes all changelog entries ever made in your project and generates a Markdown file `CHANGELOG.md` in your project root.

**Example:** `yarn run strangelog generate`

**Note:** Since that `CHANGELOG.md` file would produce merge conflicts when working with multiple people in parallel, it is recommended that you do not commit this file (at least not in feature branches). The recommended solution is to generate the `CHANGELOG.md`-file during your CI build and publish it as an artifact.