Skip to content
Generic, high-level Git workflow support!
Branch: master
Clone or download
allewun and kevgo Update docs (#1200)
* update docs

* formatting

* formatting

* formatting

* formatting

* https where possible

* docs

* https

* fix tests
Latest commit 9361547 Apr 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github StaleBot configuration (#1193) Apr 2, 2019
documentation Update docs (#1200) Apr 25, 2019
features
package Markdown Autoformatter (#1064) Dec 5, 2017
src Update docs (#1200) Apr 25, 2019
text-run Verify Make commands (#1171) Sep 6, 2018
vendor
website Fix hosting service camelCasing (#1199) Apr 22, 2019
.editorconfig Update docs (#1200) Apr 25, 2019
.gitignore use build flags (#1137) Apr 17, 2018
.hound.yml Fix HoundCI configuration Mar 25, 2015
.rubocop.yml Add Harp dev dependency (#1170) Aug 30, 2018
.ruby-version Ruby 2.4.1 Aug 7, 2017
.travis.yml Verify command documentation via Text-Runner (#1161) Aug 30, 2018
CONTRIBUTING.md
Gemfile Update docs (#1200) Apr 25, 2019
Gemfile.lock Update docs (#1200) Apr 25, 2019
Gopkg.lock Use dep instead of glide for dependency management (#1195) Apr 21, 2019
Gopkg.toml Use dep instead of glide for dependency management (#1195) Apr 21, 2019
LICENSE Update LICENSE to 2018 (#1160) Jun 28, 2018
Makefile Use dep instead of glide for dependency management (#1195) Apr 21, 2019
README.md Update docs (#1200) Apr 25, 2019
RELEASE_NOTES.md Verify command documentation via Text-Runner (#1161) Aug 30, 2018
cucumber.yml
cucumber_lint.yml refactor steps to use tables Dec 26, 2016
doc.go Godoc (#1058) Nov 22, 2017
main.go move all go code into src folder (#889) Apr 28, 2017
package.json Update dependencies (#1194) Apr 16, 2019
tertestrial.yml
text-run.yml
yarn.lock

README.md

Git Town

Build Status Go Report Card License Help Contribute to Open Source

Git Town makes software development teams who use Git even more productive and happy. It adds Git commands that support GitHub Flow, Git Flow, the Nvie model, GitLab Flow, and other workflows more directly, and it allows you to perform many common Git operations faster and easier.

See git-town.com for documentation and this Softpedia article for an independent review.

Commands

Git Town provides these additional Git commands:

Development Workflow

Repository Maintenance

Git Town Configuration

Other Commands

Installation

Since version 4.0, Git Town runs natively on all platforms without any dependencies. Check out our installation instructions for more details.

Aliasing

Each command can be aliased individually to remove the town prefix with:

git config --global alias.hack 'town hack'

Now you can run git hack instead of git town hack. As a convenience, you can add or remove global aliases for all git-town commands with:

git town alias <true | false>

Configuration

Git Town is configured on a per-repository basis. Upon first use in a repository, you will be prompted for the required configuration. Use the git town config command to view or update your configuration at any time.

Required configuration

Optional Configuration

The following configuration options have defaults, so the configuration wizard does not ask about them.

  • the pull branch strategy

    • how to sync the main branch / perennial branches with their upstream
    • default: rebase
    • possible values: merge, rebase
  • the new branch push flag

    • whether or not branches created by hack / append / prepend should be pushed to remote repo
    • default: false
    • possible values: true, false

Documentation

In addition to the online documentation here, you can run git town on the command line for an overview of the Git Town commands, or git help <command> (e.g. git help sync) for help with an individual command.

Contributing

Found a bug or have an idea for a new feature? Open an issue or - even better - get down, go to town, and fire a feature-tested pull request our way! Check out our contributing guide to start coding.

You can’t perform that action at this time.