Giter VIP home page Giter VIP logo

keepachangelog-parser's Introduction

KeepAChangeLog-Parser

A simple shell parser designed to check the format of changelogs against https://keepachangelog.com/en/1.0.0/

Who would use this?

Anyone using bash scripts to check changelog formats. Developed specifically with Gitlab CI/CD in mind, this can be used with any CI pipeline that uses bash to run scripts.

How to use this?

Set script as executable and run without any parameters. The script by default looks for a CHANGELOG.md in the directory it was run in.

How it works

Reads a CHANGELOG.md file line by line and uses RegEx matching to look for versions and then ensures that each version has a changetype and a comment.

keepachangelog-parser's People

Contributors

filmo003 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.