Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Twenga/twgit

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.
https://github.com/Twenga/twgit

Last synced: about 2 months ago
JSON representation

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.

Awesome Lists containing this project

README

        

[![TwGit logo](https://github.com/Twenga/twgit/raw/stable/doc/logo-med.png)](http://twgit.twenga.com/) TwGit
==========

#### [Homepage](http://twgit.twenga.com/)

## 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](https://github.com/nvie/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](https://about.gitlab.com), [Jira](https://www.atlassian.com/fr/wac/software/jira),
[Redmine](http://www.redmine.org), [Trello](https://trello.com) and [Pivotal Tracker](https://www.pivotaltracker.com) 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`:

```bash
$ git clone [email protected]:Twenga/twgit.git .
$ sudo make install
```

More [Installation instructions](https://github.com/Twenga/twgit/wiki/Twgit#wiki-2.installation) are available in French wiki, waiting English translation...

## Getting started

![Getting started](doc/getting-started.png)

## Documentation

[French documentation](https://github.com/Twenga/twgit/wiki) is available in wiki, waiting English translation...

### Help on command prompt

![twgit](doc/screenshot-twgit.png)

![twgit feature](doc/screenshot-twgit-feature.png)

![twgit hotfix](doc/screenshot-twgit-hotfix.png)

![twgit release](doc/screenshot-twgit-release.png)

![twgit demo](doc/screenshot-twgit-demo.png)

![twgit tag](doc/screenshot-twgit-tag.png)

## Continuous integration [![travis-ci.org](doc/travis-favicon.png)](http://travis-ci.org/Twenga/twgit) [![Build Status](https://secure.travis-ci.org/Twenga/twgit.png?branch=stable)](http://travis-ci.org/Twenga/twgit)

To run the test suite locally, simply:

```bash
$ 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](.travis.yml)):

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

[Estimated code coverage](https://travis-ci.org/Twenga/twgit): 33.1% (661 of 1994 lines).

## Copyrights & licensing

Licensed under the Apache License 2.0.
See [LICENSE](LICENSE) file for details.

## ChangeLog

See [CHANGELOG](CHANGELOG.md) file for details.