Skip to content

Latest commit

 

History

History
265 lines (180 loc) · 7.37 KB

README.md

File metadata and controls

265 lines (180 loc) · 7.37 KB
Raw

Git Sync

Clones all repositories, public or private, of a specified user or organization.

Credentials are required, they are present in a file named .gitsync.json place in the home folder.

Installation:

~$ sudo npm install -g @deliverymanager/gitsync

Usage:

For pull:

~$ gitsync --pull

For clone:

~$ gitsync --clone

For both:

~$ gitsync --all
Or:
~$ gitsync -a

To (re)initialize credentials:

~$ gitsync --init

To checkout to stable branches (production/prod):

~$ gitsync --checkout
The description is used to determine the exact path to which the repository will be cloned.
If the description is not a valid path, a warning appears.

Examples:

Repository description: path/to/folder -> Will clone the repository in ./path/to/folder/<repository name>

Repository description: Some description -> Will show a warning and not clone

Authentication:

The following file, .gitsync.json, must be placed in the home folder and is required for authentication with the GitHub API:

For only public repositories:

{
  "user": <github username>,
  "user_agent": <github user_agent>,
  "sync_account": <account from which to sync>,
  "org": <true/false> // whether the sync_account is an organization
}

For private repositories as well:

{
  "user": <github username>,
  "user_agent": <github user_agent>,
  "sync_account": <account from which to sync>,
  "org": <true/false> // whether the sync_account is an organization,
  "at": <github API access token>
}

To run the tests as well, the file must look like this:

{
  "user": <github username>,
  "at": <github API access token>,
  "test_repo_1": {
    "name": <repo name>,
    "full_name": <repo full name>,
    "local_path": <local path to which the repo will be cloned>
  },
  "test_repo_2": {
    "name": <repo name>,
    "full_name": <repo full name>,
    "local_path": <local path to which the repo will be cloned>
  },
  "user_agent": <github user_agent>,
  "sync_account": <account from which to sync>,
  "org": <true/false> // whether the sync_account is an organization
}

You can place the file yourself or you could run ~$ gitsync --init which will prompt for user name and Github API access token.

~$ gitsync --init

If you try to use the script without the .gitsync.json file present in the home folder, you will be prompted to initialize it, and execution will continue after the file is created.

Note: You could omit the access token. The script will still work but only for public repositories.

API Reference

Clone

init_cred

Initializes/updates git credentials

module.exports([cred]) ⇒ Promise ⏏

Kind: Exported function
Returns: Promise - Resolves to the the output of fs.writeFile or to message: 'Credentials not updated'

Param Type Default Description
[cred] object {} Credentials to keep Reads file with credentials, prompts for creation if not found and for update if found. Creates/Updates credentials.

get_all_repos_names

Gets all user's or org's repos names

module.exports(name, org, user, at) ⇒ repos ⏏

Kind: Exported function
Returns: repos - Mapped to have attributes name, full_name, local_path

Param Type Description
name string Github username
org boolean Whether the account belongs to an organization
user string User-Agent Header
at string Github authentication token

is_path_valid

Checks for validity of path, must be string and satisfy

module.exports(path) ⇒ boolean ⏏

Kind: Exported function
Returns: boolean - Whether path is valid

Param Type Description
path string Path under which to clone a repo

clone_repo

Clones a repo in path specified if path is valid. Else, clones to cwd

module.exports(repo, at) ⇒ Promise ⏏

Kind: Exported function
Returns: Promise - Resolves to the path under which the repo was cloned

Param Type Description
repo object Repository info
repo.name string
repo.full_name string
repo.local_path string local path to which the repo will be cloned
at string Github authentication token

Pull

get_existing_repos

Finds all repository folder paths under cwd. Used to update repos status

module.exports() ⇒ Array.<string> ⏏

Kind: Exported function
Returns: Array.<string> - The repository folder paths under cwd

get_status

Updates refs for cwd

module.exports(path) ⇒ string ⏏

Kind: Exported function
Returns: string - Repo status: diverged, fast-forward, up-to-date

Param Type Description
path string The absolute path to use as an cwd with exec

pull_all

Pulls all branches for repo

module.exports(path) ⇒ string ⏏

Kind: Exported function
Returns: string - Success message

Param Type Description
path string The absolute path to use as an cwd with exec

get_all_branches

Returns all repo branches

module.exports(path) ⇒ Array.<string> ⏏

Kind: Exported function
Returns: Array.<string> - The branch names

Param Type Description
path string The absolute path to use as an cwd with exec

track_missing_branches

Creates local branches production and branches with prodv prefix, if not found

module.exports(path, branches) ⇒ Array.<string> ⏏

Kind: Exported function
Returns: Array.<string> - The branches that were added

Param Type Description
path string The absolute path to use as an cwd with exec
branches Array.<string> All repo branches