Git Product home page Git Product logo

strangelog's Introduction

strangelog

Build Status

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.

strangelog's People

Contributors

leoselig avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.