Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 2.86 KB

README.md

File metadata and controls

107 lines (80 loc) · 2.86 KB

TCG Prep

This script automates the following tasks:

  • Reload Vagrant
  • For all specified repos, checkout previous branch if in a detached head state (a common side effect of reloading Vagrant)
  • For all specified repos, pull if behind origin
  • For all specified site configs, copy production one to local counterpart

Installation

Make sure you have Python and pip installed:

python -V

pip -V

Install GitPython:

sudo pip install gitpython

In your .bashrc or .zshrc file, add something like this (you might need slightly different formatting for bash):

export PATH="/path/to/cloned/repo:$PATH"

Run this command in the repo you just cloned in order to make the script executable:

chmod +x tcg-prep

Create a file called config.py alongside tcg-prep and populate it like this, making sure to update all paths as necessary.

# directoryList is a list of repos that often become detached 
# during "vagrant reload" and require a daily pull
tf = "/path/to/tf/repo"
icm = "/path/to/icm/repo"
pubrec = "/path/to/pubrec/repo"
config = "/path/to/config/repo"
dsc = "/path/to/dsc/repo"

# directoryList[n][0] is an arbitrary name for some repo
# directoryList[n][1] is the path to that repo
directoryList = [
    ['TF', tf],
    ['ICM', icm],
    ['PUBREC', pubrec],
    ['CONFIG', config],
    ['DATA SERVICE CLIENT', dsc]
]

# siteConfigFile[n][0] must refer to a production site config
# siteConfigFile[n][1] must refer to the local counterpart
siteConfigFiles = [
    [
        "/path/to/tf-production-config.json",
        "/path/to/tf-local-config.json"
    ],
    [
        "/path/to/icm-production-config.json",
        "/path/to/icm-local-config.json"
    ]
]

Using the tool

Running tcg-prep reloads Vagrant and ensure that no repo is in a detached head state.

Add the --copy-configs flag to copy the contents of the production site config(s) to the local one(s).

Add the --skip-vagrant flag to skip the vagrant reload command.

Output

If the command tcg-prep --copy-configs is executed, you should see something like the following (once Vagrant is finally reloaded):

TF: detached head state. Checking out master.
>>> TF master branch is behind origin. Pulling.
ICM: master branch.
PUBREC: detached head state. Checking out master.
>>> PUBREC master branch is behind origin. Pulling.
CONFIG: master branch.
DATA SERVICE CLIENT: master branch.
----------------
tf-production-config.json copied to local site config.
icm-production-config.json copied to local site config.

Issues

If the program will not run, you might need to modify the first line of tcg-prep to reflect the proper location and version of the Python interpreter.

Future features

[ ] Check first if there are 1) changes not staged, and/or 2) uncommitted but staged changes. This is essential for preventing an error. [ ] Use colors for the output text.