Twgit is a free and open source assisting tools for managing features, hotfixes and releases on Git repositories. It provides simple, high-level commands to adopt the branching model describes in our documentation. Supported OS: Debian/Ubuntu Linux, Mac OS X 10.8 (Mountain Lion) or lower.
PHP Shell Makefile

README.md

TwGit logo TwGit

Homepage

Description

Twgit is a free and open source assisting tools for managing features, hotfixes and releases on Git repositories. It provides simple, high-level commands to adopt the branching model describes in our documentation (see below).

This tools is largely inspired by GitFlow, but the workflow is different.

Feel free to contribute to it if you like.

Requirements

  • Bash v4 (2009) and above or zsh
  • Git v1.7.2 (2010) and above
  • php5-cli or Python 2.x for Github, Gitlab, Jira, Redmine and Trello connectors (can be switched off): allow to display issue's title/subject into twgit
  • Supported operating systems: Debian/Ubuntu Linux, FreeBSD, Mac OS X

Installing twgit

In the directory of your choice, e.g. ~/twgit:

$ git clone git@github.com:Twenga/twgit.git .
$ sudo make install

More Installation instructions are available in French wiki, waiting English translation...

Getting started

Getting started

Documentation

French documentation is available in wiki, waiting English translation...

Help on command prompt

twgit

twgit feature

twgit hotfix

twgit release

twgit demo

twgit tag

Continuous integration travis-ci.org Build Status

To run the test suite locally, simply:

$ cp conf/twgit-dist.sh conf/twgit.sh          # and adapt, if necessary
$ cp conf/phpunit-dist.php conf/phpunit.php    # and adapt, if necessary
$ phpunit -c conf/phpunit-dist.xml

To show estimated code coverage (see .travis.yml):

$ tests/inc/codeCoverage.sh \
    <(find $(pwd)/inc -type f -name '*.sh' && echo $(pwd)/twgit) \
    <(find $(pwd) -type f -name '*Test.php')

Estimated code coverage: 33.1% (661 of 1994 lines).

Copyrights & licensing

Licensed under the Apache License 2.0. See LICENSE file for details.

ChangeLog

See CHANGELOG file for details.