Overview

GitMan is a language-agnostic dependency manager using Git. It aims to serve as a submodules replacement and provides advanced options for managing versions of nested Git repositories.

Setup

Requirements

• Python 3.6+
• Git 2.8+ (with stored credentials)

Installation

Install this tool globally:

$ pip install gitman

or add it to your Poetry project:

$ poetry add gitman

Configuration

Generate a sample config file:

$ gitman init

or manually create one (gitman.yml or .gitman.yml) in the root of your working tree:

location: vendor/gitmansources:
- name: frameworkrepo: https://github.com/kstenerud/iOS-Universal-Frameworkrev: Mk5-end-of-life
- name: coveragerepo: https://github.com/jonreid/XcodeCoveragerev: masterlink: Tools/XcodeCoverage
- name: trufflehogrepo: https://github.com/dxa4481/truffleHogrev: masterscripts:
- chmod a+x truffleHog/truffleHog.py
- name: fontawesomerepo: https://github.com/FortAwesome/Font-Awesomesparse_paths:
- "webfonts/*"rev: master
- name: material-design-iconsrepo: https://github.com/google/material-design-icons.gitrev: mastergroups:
- name: codemembers:
- framework
- trufflehog
- name: resourcesmembers:
- fontawesome
- material-design-icons

Ignore the dependency storage location:

$ echo vendor/gitman >> .gitignore

Usage

See the available commands:

$ gitman --help

Updating Dependencies

Get the latest versions of all dependencies:

$ gitman update

which will essentially:

1. Create a working tree at <root>/<location>/<name>
2. Fetch from repo and checkout the specified rev
3. Symbolically link each <location>/<name> from <root>/<link> (if specified)
4. Repeat for all nested working trees containing a config file
5. Record the actual commit SHAs that were checked out (with --lock option)
6. Run optional post-install scripts for each dependency

where rev can be:

• all or part of a commit SHA: 123def
• a tag: v1.0
• a branch: master
• a rev-parse date: 'develop@{2015-06-18 10:30:59}'

Alternatively get the latest versions of certain dependencies or even dependency groups:

• Update a single repository

$ gitman update framework

• Update a dependency group

$ gitman update resources

Restoring Previous Versions

Display the specific revisions that are currently installed:

$ gitman list

Reinstall these specific versions at a later time:

$ gitman install

Deleting Dependencies

Remove all installed dependencies:

$ gitman uninstall