git-in-sync

README

git-in-sync

Synopsis

git-in-sync parses flags, reads ~/.gisrc.json then configures directories and repositories as configured.

Overview

1. ~/.gisrc.json outlines directories and their repos as bundles and zones:

{json block showing configuration}

1. Modes are set with -m:

{Here is where the modes go}

1. Additional options can also be set:

{Here is where the additional options go}

1. .gisrc.json unmarshalled to Config struct

type Config struct {
	Zones []struct {
		Path    string `json:"path"`
		Bundles []struct {
			User     string   `json:"user"`
			Remote   string   `json:"remote"`
			Division string   `json:"division"`
			Repos    []string `json:"repositories"`
		} `json:"bundles"`
	} `json:"zones"`
}

1. The default mode is verify. In this mode:

• Verifies directory structure
• Verifies repositories existence [highlight that it's async]
• Gets Git information for each repository

1. If the repository is complete, it's marked as such. Otherwise the user is prompted to confirm the next step

   {Steps go here}

2. Once all actions have been cued...final approval...actions dispatched

Getting Started

Documentation

Overview

Package gis is the main package of git-in-sync.