update_repo 0.10.1 → 0.11.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/css/site.min.css +1 -1
- data/docs/fonts/fa-brands-400.eot +0 -0
- data/docs/fonts/fa-brands-400.svg +3535 -0
- data/docs/fonts/fa-brands-400.ttf +0 -0
- data/docs/fonts/fa-brands-400.woff +0 -0
- data/docs/fonts/fa-brands-400.woff2 +0 -0
- data/docs/fonts/fa-regular-400.eot +0 -0
- data/docs/fonts/fa-regular-400.svg +803 -0
- data/docs/fonts/fa-regular-400.ttf +0 -0
- data/docs/fonts/fa-regular-400.woff +0 -0
- data/docs/fonts/fa-regular-400.woff2 +0 -0
- data/docs/fonts/fa-solid-900.eot +0 -0
- data/docs/fonts/fa-solid-900.svg +4700 -0
- data/docs/fonts/fa-solid-900.ttf +0 -0
- data/docs/fonts/fa-solid-900.woff +0 -0
- data/docs/fonts/fa-solid-900.woff2 +0 -0
- data/docs/index.html +18 -6
- data/docs/js/main-min.js +1 -5
- data/lib/update_repo/cmd_config.rb +5 -4
- data/lib/update_repo/helpers.rb +19 -0
- data/lib/update_repo/version.rb +1 -1
- data/lib/update_repo.rb +3 -1
- data/web/.nvmrc +1 -1
- data/web/gulpfile.js +27 -22
- data/web/index.html +16 -5
- data/web/package-lock.json +2035 -2389
- data/web/package.json +23 -19
- data/web/partials/_contribute.html +1 -1
- data/web/partials/_footer.html +1 -1
- data/web/partials/_header.html +1 -3
- data/web/partials/_license.html +2 -2
- data/web/partials/_navbar.html +14 -20
- data/web/sass/site.scss +1 -11
- data/web/webdata.json +9 -0
- metadata +17 -14
- data/docs/fonts/FontAwesome.otf +0 -0
- data/docs/fonts/fontawesome-webfont.eot +0 -0
- data/docs/fonts/fontawesome-webfont.svg +0 -2671
- data/docs/fonts/fontawesome-webfont.ttf +0 -0
- data/docs/fonts/fontawesome-webfont.woff +0 -0
- data/docs/fonts/fontawesome-webfont.woff2 +0 -0
- data/docs/fonts/glyphicons-halflings-regular.eot +0 -0
- data/docs/fonts/glyphicons-halflings-regular.svg +0 -288
- data/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
- data/docs/fonts/glyphicons-halflings-regular.woff +0 -0
- data/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
- data/package-lock.json +0 -2729
|
Binary file
|
|
Binary file
|
|
Binary file
|
data/docs/index.html
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta
|
|
1
|
+
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><title>update_repo | Automate the update of multiple local Git repository clones</title><link rel="stylesheet" href="css/site.min.css"><link href="https://fonts.googleapis.com/css?family=Lato|Droid+Serif|Raleway" rel="stylesheet"><!--[if lt IE 9]>
|
|
2
2
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
3
3
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
4
|
-
<![endif]--></head><body><nav class="navbar navbar-
|
|
4
|
+
<![endif]--></head><body><nav class="navbar navbar-expand-lg fixed-top"><div class="container"><a class="navbar-brand" href="#">Update_Repo</a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"><span class="navbar-toggler-icon"></span></button><div class="collapse navbar-collapse" id="navbarCollapse"><ul class="navbar-nav mr-auto"><li class="nav-item"><a class="nav-link" href="#about">About</a></li><li class="nav-item"><a class="nav-link" href="#installation">Installation</a></li><li class="nav-item"><a class="nav-link" href="#usage">Usage</a></li><li class="nav-item"><a class="nav-link" href="#configuration">Configuration</a></li><li class="nav-item"><a class="nav-link" href="#contribute">Contribute</a></li><li class="nav-item"><a class="nav-link" href="#license">License</a></li></ul></div></div></nav><section class="about" id="about"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-info-circle"></span> About</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><p>A Simple Gem to keep multiple locally-cloned Git Repositories up to date. Current release version is <span id="version" class="version"></span></p><p>The script will simply run <span class="console-output">git pull</span> on every local clone of a git repository that it finds under the specified directory or directories.</p><p class="important-note">Note: Versions prior to 0.9.4 had a serious bug where the script would crash on startup unless there was an <span class="yaml-tag">exception:</span> defined in the configuration file. This has been fixed from version 0.9.4 onwards.</p><div class="text-center"><a href="https://travis-ci.org/seapagan/update_repo"><img src="https://travis-ci.org/seapagan/update_repo.svg?branch=master"></a></div></div></div></div></section><section class="installation" id="installation"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-download"></span> Installation</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><p>A working copy of both <a href="http://www.ruby-lang.org" target="_blank" class="icon fa-external-link">Ruby</a> and <a href="http://git-scm.com" target="_blank" class="icon fa-external-link">Git</a> need to be installed on your machine. <b>Git version 1.8.5 or greater is required</b>, the script will not run with an older version or indeed without Git installed. Ruby version 2.3.0 and newer are supported (older versions will probably work, however they error on the Travis CI system so cannot be automatically tested).</p><p>Currently the script has only been tested under Linux, not Windows however Windows testing is next in the grand plan!</p><p>Simply install from the command prompt as you would any other gem. Note that you may require <b>'sudo'</b> depending how Ruby is installed on your system.</p><pre><code>gem install update_repo</code></pre></div></div></div></section><section class="usage" id="usage"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-check-square"></span> Usage</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><h2>Quick Start</h2><p>Create a <a class="icon fa-external-link" target="_blank" href="http://yaml.org/">YAML</a>-formatted configuration file called <span class="filename">.updaterepo</span> (note the 'dot' at the start!) in your home directory that contains at least a <span class="yaml-tag">location:</span> tag pointing to the directory containing the git repositories you wish to have updated :</p><pre>
|
|
5
5
|
<code class="language-yaml">
|
|
6
6
|
---
|
|
7
7
|
location:
|
|
8
8
|
- /media/myuser/git-repos
|
|
9
9
|
- /data/RepoDir
|
|
10
10
|
</code>
|
|
11
|
-
</pre><p>The directory or directories specified (there can be 1 root directory or as many as you wish) must already exist, and can be nested as deep as you wish with many repositories in many subdirectories.</p><p>This is the most basic example of a configuration file and there are other options that can be added to fine-tune the operation - see the description of configuration options below.</p><p>Now, run the script from anywhere :</p><pre><code>update_repo</code></pre><p><b>Note:</b> From version 0.9.0 onwards, the default mode of operation is <b>non-verbose</b>. If you wish the same output as previous versions then specify <span class="cmdline">--verbose</span> on the command line or <span class="yaml-tag">verbose: true</span> in the configuration file.</p></div></div></div></section><section class="configuration" id="configuration"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1 class="
|
|
11
|
+
</pre><p>The directory or directories specified (there can be 1 root directory or as many as you wish) must already exist, and can be nested as deep as you wish with many repositories in many subdirectories.</p><p>This is the most basic example of a configuration file and there are other options that can be added to fine-tune the operation - see the description of configuration options below.</p><p>Now, run the script from anywhere :</p><pre><code>update_repo</code></pre><p><b>Note:</b> From version 0.9.0 onwards, the default mode of operation is <b>non-verbose</b>. If you wish the same output as previous versions then specify <span class="cmdline">--verbose</span> on the command line or <span class="yaml-tag">verbose: true</span> in the configuration file.</p></div></div></div></section><section class="configuration" id="configuration"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-cog"></span> Configuration</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><h2>Configuration file</h2><p>The configuration file defaults to <span class="filename">~/.updaterepo</span> and is a standard <a href="http://yaml.org/" class="icon fa-external-link">YAML</a> formatted text file. If this configuration file is not found, the script will terminate with an error.</p><p>The first line <b>must</b> contain only the YAML frontmatter of 3 dashes (<span class="yaml-tag">---</span>). After that, the following sections can follow in any order. Only the <span class="yaml-tag">location:</span> section is compulsory, and that must contain at least one entry.</p></div><div class="col-lg-12 col-md-12"><p><span class="yaml-tag">location:</span> - at least one directory which contains the locally cloned repository(s) to update. There is no limit on how many directories can be listed :</p><pre>
|
|
12
12
|
<code class="language-yaml">
|
|
13
13
|
---
|
|
14
14
|
location:
|
|
@@ -53,6 +53,14 @@
|
|
|
53
53
|
<code class="language-yaml">
|
|
54
54
|
quiet: true
|
|
55
55
|
</code>
|
|
56
|
+
</pre></div><div class="col-lg-12 col-md-12"><p><span class="yaml-tag">save_errors:</span> - Enable or disable the option to save any Git errors from a previous run of the script, defaults to FALSE (optional). If this is specified then there will be nothing printed to the terminal except for fatal errors. Equivalent to <span class="cmdline">--save-errors</span> on the command line. Once saved, errors can be displayed using the <span class="cmdline">--show-errors</span> command line option.</p><pre>
|
|
57
|
+
<code class="language-yaml">
|
|
58
|
+
save_errors: true
|
|
59
|
+
</code>
|
|
60
|
+
</pre></div><div class="col-lg-12 col-md-12"><p><span class="yaml-tag">noinetchk:</span> - Enable or disable checking for a working Internet connection before running the script, defaults to FALSE (optional). Equivalent to <span class="cmdline">--noinetchk</span> on the command line.</p><pre>
|
|
61
|
+
<code class="language-yaml">
|
|
62
|
+
noinetchk: true
|
|
63
|
+
</code>
|
|
56
64
|
</pre></div><div class="col-lg-12 col-md-12"><p>Putting these together, below is an example <span class="filename">.updaterepo</span> file :</p><pre>
|
|
57
65
|
<code class="language-yaml">
|
|
58
66
|
---
|
|
@@ -67,6 +75,7 @@
|
|
|
67
75
|
color: false
|
|
68
76
|
verbose: true
|
|
69
77
|
verbose_errors: true
|
|
78
|
+
save_errors: true
|
|
70
79
|
brief: false
|
|
71
80
|
quiet: false
|
|
72
81
|
</code>
|
|
@@ -84,14 +93,17 @@
|
|
|
84
93
|
-E, --verbose-errors List all the error output from a failing command in the summary, not just the first line
|
|
85
94
|
-b, --brief Do not print the header, footer or summary
|
|
86
95
|
-q, --quiet Run completely silent, with no output to the terminal (except fatal errors)
|
|
96
|
+
-s, --save-errors Save any Git error messages from the last run for future display
|
|
97
|
+
-S, --show-errors Show any Git error messages from the last run of the script
|
|
98
|
+
-n, --noinetchk Do not check for a working Internet connection before running the script
|
|
87
99
|
-v, --version Print version and exit
|
|
88
100
|
-h, --help Show this message
|
|
89
101
|
</code>
|
|
90
|
-
</pre></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Color</p></div><div class="cmd-body row-body"><p class="cmd-text">Determines if the output will be displayed in color or not. Default is TRUE. Note that regardless of this setting, when one of the '--dump-*' options is specified output will not be in color. No color codes will be saved to the logfile either.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">color:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--color</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-c</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-color</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">true</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a CSV file of each directory and its associated git remote URL to the console, and to the logfile if that is enabled.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-d</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Prune</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --dump option to remove the first <integer> directory levels from the output. This will enable it to be imported back into a different directory structure.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">prune:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--prune</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-p</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">0</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log</p></div><div class="cmd-body row-body"><p class="cmd-text">Copies all script output to a logfile as well as STDOUT. The default logfile name is 'updaterepo.log' in the current users home directory. The previous log will be overwritten, but see the next option.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-l</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Timestamp</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --log option to rename the logfile with an added timestamp, thus not overwriting older logs</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">timestamp:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--timestamp</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-t</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-timestamp</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log Local</p></div><div class="cmd-body row-body"><p class="cmd-text">Store the logfile (if this is enabled) in the current working directory instead of the Users' Home directory</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log_local:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log-local</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-g</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log-local</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose</p></div><div class="cmd-body row-body"><p class="cmd-text">Display all raw Git output plus repository URL and location instead of the reduced output in the default mode. Note that the short-form command is the UPERCASE 'V' not lower!</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-V</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">List all the error output from a failing command in the summary, not just the first line</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose_errors:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-E</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose-errors</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Brief Output</p></div><div class="cmd-body row-body"><p class="cmd-text">Do not print the Header, Footer or Summary.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">brief:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--brief</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-b</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-brief</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Quiet</p></div><div class="cmd-body row-body"><p class="cmd-text">No output will be displayed to screen during the running of script, except for any fatal errors.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">quiet:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--quiet</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-q</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-quiet</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump Remotes</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a bare list to the console of all the Git remote URL's found in the specified directories. This can be saved by redirecting to file or using the --log option.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump-remotes</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-r</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Version</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays the current version number then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--version</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-v</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Help</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays a brief help text listing syntax and availiable switches then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--help</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-h</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div></div></div></section><section class="contribute" id="contribute"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1 class="icon fa-code-fork">Contribute to the Development</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><h2>Contributing</h2><p>The source code for <span class="console-output">update_repo</span> is freely available on my <a target="_blank" class="icon fa-external-link" href="https://github.com/seapagan/update_repo">Github</a> pages, under the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> license.</p><p>If you wish to help in any way then :</p><ol><li>Fork it</li><li>Create your feature branch (<span class="console-output">git checkout -b my-new-feature</span>)</li><li>Commit your changes (<span class="console-output">git commit -am 'Add some feature'</span>)</li><li>Push to the branch (<span class="console-output">git push origin my-new-feature</span>)</li><li>Create a new Pull Request</li></ol><p>For full information on how to contribute to the development of this Gem or the Website, please see the Development section on the projects <a class="icon fa-external-link" target="_blank" href="https://github.com/seapagan/update_repo#development">Github repository</a>.</p></div></div></div></section><section class="license" id="license"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1 class="icon fa-book">License</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><p>The gem is available as open source under the terms of the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> License, see the file <span class="filename">LICENSE.txt</span>, also reproduced below :</p><pre>
|
|
102
|
+
</pre></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Color</p></div><div class="cmd-body row-body"><p class="cmd-text">Determines if the output will be displayed in color or not. Default is TRUE. Note that regardless of this setting, when one of the '--dump-*' options is specified output will not be in color. No color codes will be saved to the logfile either.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">color:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--color</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-c</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-color</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">true</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a CSV file of each directory and its associated git remote URL to the console, and to the logfile if that is enabled.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-d</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Prune</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --dump option to remove the first <integer> directory levels from the output. This will enable it to be imported back into a different directory structure.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">prune:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--prune</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-p</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">0</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log</p></div><div class="cmd-body row-body"><p class="cmd-text">Copies all script output to a logfile as well as STDOUT. The default logfile name is 'updaterepo.log' in the current users home directory. The previous log will be overwritten, but see the next option.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-l</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Timestamp</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --log option to rename the logfile with an added timestamp, thus not overwriting older logs</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">timestamp:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--timestamp</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-t</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-timestamp</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log Local</p></div><div class="cmd-body row-body"><p class="cmd-text">Store the logfile (if this is enabled) in the current working directory instead of the Users' Home directory</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log_local:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log-local</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-g</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log-local</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose</p></div><div class="cmd-body row-body"><p class="cmd-text">Display all raw Git output plus repository URL and location instead of the reduced output in the default mode. Note that the short-form command is the UPERCASE 'V' not lower!</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-V</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">List all the error output from a failing command in the summary, not just the first line</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose_errors:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-E</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose-errors</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Brief Output</p></div><div class="cmd-body row-body"><p class="cmd-text">Do not print the Header, Footer or Summary.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">brief:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--brief</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-b</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-brief</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Quiet</p></div><div class="cmd-body row-body"><p class="cmd-text">No output will be displayed to screen during the running of script, except for any fatal errors.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">quiet:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--quiet</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-q</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-quiet</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump Remotes</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a bare list to the console of all the Git remote URL's found in the specified directories. This can be saved by redirecting to file or using the --log option.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump-remotes</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-r</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Save Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">Save any Git error messages from the last run for future display. These can be displayed using the Show Errors command below, which will display previous errors then exit without running another pass.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">save_errors</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--save-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-s</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Show Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">Prints any errors detected in the previous run then exits. This needs the 'Save Errors' option above to be enabled.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--show-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-S</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>No Internet connection check</p></div><div class="cmd-body row-body"><p class="cmd-text">Does not check for a working Internet connection before running the Script.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">noinetchk</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--noinetchk</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-n</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Version</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays the current version number then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--version</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-v</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Help</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays a brief help text listing syntax and availiable switches then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--help</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-h</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div></div></div></section><section class="contribute" id="contribute"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-code-branch"></span> Contribute to the Development</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><h2>Contributing</h2><p>The source code for <span class="console-output">update_repo</span> is freely available on my <a target="_blank" class="icon fa-external-link" href="https://github.com/seapagan/update_repo">Github</a> pages, under the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> license.</p><p>If you wish to help in any way then :</p><ol><li>Fork it</li><li>Create your feature branch (<span class="console-output">git checkout -b my-new-feature</span>)</li><li>Commit your changes (<span class="console-output">git commit -am 'Add some feature'</span>)</li><li>Push to the branch (<span class="console-output">git push origin my-new-feature</span>)</li><li>Create a new Pull Request</li></ol><p>For full information on how to contribute to the development of this Gem or the Website, please see the Development section on the projects <a class="icon fa-external-link" target="_blank" href="https://github.com/seapagan/update_repo#development">Github repository</a>.</p></div></div></div></section><section class="license" id="license"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-book"></span> License</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><p>The gem is available as open source under the terms of the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> License, see the file <span class="filename">LICENSE.txt</span>, also reproduced below :</p><pre>
|
|
91
103
|
<code class="language-markup">
|
|
92
104
|
The MIT License (MIT)
|
|
93
105
|
|
|
94
|
-
Copyright (c)
|
|
106
|
+
Copyright (c) 2019 Grant Ramsay
|
|
95
107
|
|
|
96
108
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
97
109
|
of this software and associated documentation files (the "Software"), to deal
|
|
@@ -111,4 +123,4 @@
|
|
|
111
123
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
112
124
|
THE SOFTWARE.
|
|
113
125
|
</code>
|
|
114
|
-
</pre></div></div></div></section><footer class="footer"><div class="container"><div class="row"><div class="col-lg-12 text-right">© Grant Ramsay
|
|
126
|
+
</pre></div></div></div></section><footer class="footer"><div class="container"><div class="row"><div class="col-lg-12 text-right">© Grant Ramsay 2019 | <span class="site-version">Website v2.0-beta</span> | See my public projects on <a target="_blank" class="icon fa-github" href="https://github.com/seapagan">Github</a></div></div></div></footer><script src="js/main-min.js"></script></body></html>
|