wtsi-hgi/git-common-sync

Name: git-common-sync

Owner: Wellcome Trust Sanger Institute - Human Genetics Informatics

Description: A tool to synchronise common files between Git repositories

Created: 2017-06-20 17:31:21.0

Updated: 2017-07-19 09:32:30.0

Pushed: 2017-09-26 13:25:55.0

Homepage:

Size: 110

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Git Common Sync

A tool to synchronise common files between Git repositories.

Features

• Programmatically synchronises git repositories according to a specification.
• Supports synchronisation of:
  • Files and directories.
  • Directories managed by git-subrepo.
  • Content generated using templates and project specific values.
• Ansible support.

How to use

Prerequisites

• git >= 2.10.0
• git-subrepo >= 0.3.1
• python >= 3.6
• rsync >= 3.1.1

Installation

Ansible Module

tcommonsync:
repository: http://www.example.com/repository.git
author_name: Ansible Synchroniser
author_email: team@example.com
key_file: /custom/id_rsa
files:
  - src: /example/README.md
    dest: README.md
    overwrite: false
  - src: /example/directory/
    dest: config
templates:
  - src: /example/ansible-groups.sh.j2
    dest: ci/before_scripts.d/start.sh
    variables:
      message: "Hello world"
    overwrite: true
subrepos:
  - src: http://www.example.com/other-repository.git
    dest: subrepos/other-repository
    branch: master
    overwrite: true

Development

Setup

Install both library dependencies and the dependencies needed for testing:

p install -q -r requirements.txt
p install -q -r test_requirements.txt

Testing

To run the tests and generate a coverage report with unittest:

st-runner.sh

If you wish to run the tests inside a Docker container (recommended), build Docker.test.

Alternatives

• Powerful but complex Ruby based alternative from the Puppet community: https://github.com/voxpupuli/modulesync.

License

MIT license.

Copyright (c) 2017 Genome Research Limited