Code Monkey home page Code Monkey logo

git-toolkit's Introduction

Git Toolkit

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

develop branch:

Build Status


This toolkit only contains one tool currently. That tool will create a changelog.md for a project using the git repository tags and the git commit history.

Installation

    composer require --dev chancegarcia/git-toolkit

General Usage

Unless specified in a config file, the repository found in the current working directory will be used.

Configuration (optional)

Default values for some command arguments and options can be set via a config file in

config/chancegarcia_git_toolkit.php

A .dist file provides an example of configuration options.

The following values are configurable:

  • project_root: the directory where the repository resides
  • project_name: The main header value
  • filename: name of the markdown file to write out.
  • output_directory: path to where the markdown file should be written

ChangeLog Command Usage

    ./vendor/bin/toolkit toolkit:changelog toolkit:changelog

The changelog file will produce a markdown document with a main header (optionally set by the header argument) of Projecty McProjectFace. Tag names are the subheaders and the commits between the tags are printed after the subheader

While you can run the base command, without a header argument, to produce a changelog, you might want to pass the a main header argument with it. Unless you really want to have the top header be Projecty McProjectFace (totally not judging) .

    ./vendor/bin/toolkit toolkit:changelog toolkit:changelog "I am not a cat."

Prepare a new or initial release tag/number

If no tags are present. The subheader will be the commit id.

In order to "create" a new tag, use the --new-tag=<NEWTAG> to set the new header and write all recent commits since the previous tag (if there is one) into the changelog.

    ./vendor/chancegarcia/git-toolkit/bin/toolkit toolkit:changelog "We Love Kittens" --new-tag="1.0.0"

git-toolkit's People

Contributors

chancegarcia avatar

Watchers

 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.