gilt¶

gilt - A GIT layering tool.

Quick Start¶

Install gilt using pip:

$ pip install python-gilt

Overlay remote repositories and/or files into the destinations provided.

$ gilt --debug overlay

Documentation¶

https://gilt.readthedocs.io/

License¶

MIT

The logo is licensed under the Creative Commons NoDerivatives 4.0 License. If you have some other use in mind, contact us.

Usage:¶

Overlay a remote repository into the destination provided.

gilt.yml¶

  - git: https://github.com/retr0h/ansible-etcd.git
    version: master
    dst: roles/retr0h.ansible-etcd/

$ gilt overlay

Overlay files from a remote repository into the destinations provided.

gilt.yml¶

  - git: https://github.com/lorin/openstack-ansible-modules.git
    version: master
    files:
      - src: "*_manage"
        dst: library/
      - src: nova_quota
        dst: library/
      - src: neutron_router
        dst: library/neutron_router.py

$ gilt overlay

Overlay a directory from a remote repository into the destination provided.

gilt.yml¶

  - git: https://github.com/blueboxgroup/ursula.git
    version: master
    files:
      - src: roles/logging
        dst: roles/blueboxgroup.logging/

$ gilt overlay

Optionally, override gilt’s cache location (defaults to ~/.gilt):

$ export GILT_CACHE_DIRECTORY=~/my-gilt-cache

Overlay files and a directory and run post-overlay commands.

gilt.yml¶

  - git: https://github.com/example/subproject.git
    version: master
    files:
      - src: subtool/test
        dst: ext/subtool.test/
        post_commands:
          - make

  - git: https://github.com/example/subtool2.git
    version: master
    dst: ext/subtool2/
    post_commands:
      - make

$ gilt overlay

Display the git commands being executed.

$ gilt --debug overlay

Use an alternate config file (default gilt.yml).

$ gilt --config /path/to/gilt.yml overlay

Molecule¶

Integrates with Molecule as an Ansible Galaxy CLI replacement. Update molecule.yml with the following.

---
dependency:
  name: shell
  command: gilt overlay

Similar Tools¶

Ansible Galaxy

Testing¶

$ pip install tox
$ tox

Contributing¶

We are interested in various different kinds of improvement for Gilt; please feel free to raise an Issue if you would like to work on something major to ensure efficient collaboration and avoid duplicate effort.
Create a topic branch from where you want to base your work.
Check for unnecessary whitespace with git diff --check before committing.
Make sure you have added tests for your changes.
Run all the tests to ensure nothing else was accidentally broken.
Reformat the code by following the formatting section below.
Submit a pull request.

Testing¶

Dependencies¶

Install the test framework Tox.

$ pip install tox

Unit¶

Unit tests are invoked by Tox.

$ tox

Formatting¶

The formatting is done using Black.

From the root for the project, run:

$ tox -e format

Development¶

Please read the Contributing guidelines.

Branches¶

The master branch is stable. Major changes should be performed elsewhere.

Release Engineering¶

Pre-release¶

Edit the History.
Follow the Testing steps.

Release¶

Gilt follows Semantic Versioning.

Tag the release and push to github.com¶

$ git tag 2.0.0
$ git push --tags

Upload to PyPI ¶

Upload to PyPI.

$ tox -e build-dists
$ tox -e publish-dists

Post-release¶

Comment/close any relevant Issues.

Roadmap¶

See Issues on Github.com.

History¶

1.2.3. ===

Add bitbucket support.
Add CI.
Correct hard coded paths in tests.
Remove black skip-string-normalization.
Add coverage.
Switched to setuptools vs pbr.
Switched to black off yapf.
Added hacking for extra lint.
Corrected docstrings.

1.2.2¶

Cleanup dst prior to checkout-index.
Fix ambigous variable usage.
Fixed deprecation of getfuncargvalue.
Remove use of deprecated pytest.config.
Fixed test failure with GILT_CACHE_DIRECTORY.
Fix tox failure due to use of relative path with –cov.

1.2.1¶

Use proper package name for pbr.

1.2¶

Add option to override gilt’s default cache dir.

1.1¶

Add support for running commands after a sync has happened.
Added python 3 support.
Suppress doc building warnings.
Only fetch when branch/tag/commit not on local repo.
Determine branch in a smarter way.

1.0¶

Initial release.

Credits¶

Development Leads¶

John Dewey (@retr0h)

Core Committers¶

Contributors¶

$ git shortlog -s | cut -c8-

Autodoc¶

Config¶

exception gilt.config.ParseError¶: Error raised when a config can’t be loaded properly.

gilt.config.config(filename)¶

Construct Config object and return a list.

Parse filename:	A string containing the path to YAML file.
Returns:	list

Git¶

gilt.git.clone(name, repository, destination, debug=False)¶

Clone the specified repository into a temporary directory and return None.

Parameters:	name – A string containing the name of the repository being cloned. repository – A string containing the repository to clone. destination – A string containing the directory to clone the repository into. debug – An optional bool to toggle debug output.
Returns:	None

gilt.git.extract(repository, destination, version, debug=False)¶

Extract the specified repository/version into the directory and return None.

Parameters:	repository – A string containing the path to the repository to be extracted. destination – A string containing the directory to clone the repository into. Relative to the directory `gilt` is running in. Must end with a ‘/’. version – A string containing the branch/tag/sha to be exported. debug – An optional bool to toggle debug output.
Returns:	None

gilt.git.overlay(repository, files, version, debug=False)¶

Overlay files from repository/version into the directory and return None.

Parameters:	repository – A string containing the path to the repository to be extracted. files – A list of FileConfig objects. version – A string containing the branch/tag/sha to be exported. debug – An optional bool to toggle debug output.
Returns:	None

Util¶

gilt.util.build_sh_cmd(cmd, cwd=None)¶

Build a sh.Command from a string.

Parameters:	cmd – String with the command to convert. cwd – Optional path to use as working directory.
Returns:	sh.Command

gilt.util.copy(src, dst)¶

Handle the copying of a file or directory.

The destination basedir _must_ exist.

Parameters:	src – A string containing the path of the source to copy. If the source ends with a ‘/’, will become a recursive directory copy of source. dst – A string containing the path to the destination. If the destination ends with a ‘/’, will copy into the target directory.
Returns:	None

gilt.util.print_info(msg)¶: Print the given message to STDOUT.

gilt.util.print_warn(msg)¶: Print the given message to STDOUT in YELLOW.

gilt.util.run_command(cmd, debug=False)¶

Execute the given command and return None.

Parameters:	cmd – A sh.Command object to execute. debug – An optional bool to toggle debug output.
Returns:	None

gilt.util.saved_cwd()¶: Context manager to restore previous working directory.

gilt¶

Quick Start¶

Documentation¶

License¶

Usage:¶

Molecule¶

Similar Tools¶

Testing¶

Contributing¶

Testing¶

Dependencies¶

Unit¶

Formatting¶

Development¶

Branches¶

Release Engineering¶

Pre-release¶

Release¶

Tag the release and push to github.com¶

Upload to PyPI ¶

Post-release¶

Roadmap¶

History¶

1.2.2¶

1.2.1¶

1.2¶

1.1¶

1.0¶

Credits¶

Development Leads¶

Core Committers¶

Contributors¶

Autodoc¶

Config¶

Git¶

Util¶

Indices and tables¶

Navigation

gilt¶

Quick Start¶

Documentation¶

License¶

Usage:¶

Molecule¶

Similar Tools¶

Testing¶

Contributing¶

Testing¶

Dependencies¶

Unit¶

Formatting¶

Development¶

Branches¶

Release Engineering¶

Pre-release¶

Release¶

Tag the release and push to github.com¶

Upload to PyPI¶

Post-release¶

Roadmap¶

History¶

1.2.2¶

1.2.1¶

1.2¶

1.1¶

1.0¶

Credits¶

Development Leads¶

Core Committers¶

Contributors¶

Autodoc¶

Config¶

Git¶

Util¶

Indices and tables¶

Upload to PyPI ¶