Giter VIP home page Giter VIP logo

changelog-rs's Introduction

Changelog toolkit

is supposed to replace manual maintenance where possible, while still leaving the release author in control.

When cutting a new release, it might come handy to have following automated:

  • validate Unreleased section items; failure must tell what needs to be fixed
  • add links where possible (PRs, issues, components, authors, maybe even tag names)
  • pre-release: replace the Unreleased section name with current tag and date
  • post-release: auto-add the Unreleased section
  • post-release: upload latest section to Github Release changelog
  • import: explore commits since last release, show omitted changes(PRs) and suggest new entries on console

These form elementary actions useful during release.

Starting with a new project

is easy:

changelog new

and it generates a CHANGELOG.md file, with minimalistic structure ready for adding new items.

First time use on a live project

changelog init

This time, commit messages will be read from git, and with some effort to remove ballast and organize them into well-known groups.

If there are release git tags, they will be used to create version sections in the changelog.

Regular use

changelog sync

Updates changelog with new commit messages from git.

An attempt will be made to only add what is really missing. Last release found in changelog will be the stopping point for git scanning. Any commits referencing issues which are already in Unreleased part will be unchanged.

changelog-rs's People

Contributors

pkozelka avatar

Watchers

 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.