-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added usage example, documented in the README
- Loading branch information
EsGeh
authored and
EsGeh
committed
Nov 27, 2019
1 parent
da033cc
commit fa8f7cb
Showing
2 changed files
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,33 @@ | ||
# git_deps_py | ||
|
||
manage dependencies between git repositories (poor mans "git submodules") | ||
manage dependencies between git repositories (lightweight "git submodules") | ||
|
||
# Status | ||
|
||
- TODO | ||
- experimental | ||
|
||
# Features | ||
|
||
- Standardized way how to document and manage dependencies to other repositories | ||
- For each dependency an init script can be specified | ||
- Reasonable behaviour of indirect dependencies (e.g. avoid redundant downloads and init scripts) | ||
|
||
# Usage Example | ||
|
||
consider `example` your git project with dependencies. Lets cd into it: | ||
|
||
$ cd example | ||
$ ls | ||
> dependencies.conf | ||
|
||
`dependencies.conf` specifies the dependencies. | ||
Open it in your favourite editor to see how it is constructed. | ||
Let's install the dependencies: | ||
|
||
$ ../get_deps.py | ||
|
||
This will clone the git repositories specified in `dependencies.conf` into a folder (default: `./dependencies/`). | ||
Also, for each dependency the specified versions (git hash) are "checked out" and the init script (if specified) is run. | ||
To see default settings and learn the command line arguments, run: | ||
|
||
$ ../get_deps.py --help |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[test] | ||
|
||
uri = https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts.git | ||
hash = 5bf3c45a5c0b822eb425038c2ceb14722694dbe0 | ||
init = scripts/init.py |