git-utils

Modularized configuration and helper scripts around git¹ usage with multiple repositories and branches.

All these scripts are NOT speed optimized! I'm using these scripts often in my daily work, and they do what they have to do.

1. Requirements

git¹

Most of these scripts are requires UNIX/Linux standard tools and commands like:

GNU core-utils⁵
GNU bash⁶

All scripts are daily used with GNU bash, version 3.2.57(1)-release (x86_64-apple-darwin17) on macOS High Sierra and also tested with:

GNU bash, Version 4.4.12(3)-release (x86_64-unknown-cygwin) on Cygwin 2.11.1
GNU bash, version 4.4.19(2)-release (x86_64-pc-msys) on Git for Windows 2.18.0

Each script checks the required tools and exits with an error if a required tool is not available. Please check the script documentation for additional and/or deviating requirements.

2. Install and Usage

Clone this repository and add it to your PATH environment variable.

Most of these scripts has a help-option (-h, -?), a quiet-option (-q) and a multi-level verbose-option (-vv...).

The usage information will be displayed if a script will execute without any arguments or with a help-option (-h, -?).

3. Modularized git Configuration

A modularized git configuration offers the possibility to work quickly and easily in various git repositories without manual changes.
This behavior based on Conditional includes in git.

See here for more information about.

4. ShellCheck

ShellCheck³ is a static analysis tool for shell scripts and I'm use it to check my scripts and try to prevent pitfalls. ShellCheck³ must be configured with the extended option -x to validate these scripts correctly.

5. License

All these scripts and configuration files are licensed under the Apache License, Version 2.0⁴. A copy of this license could be also found in the LICENSE file.

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# (c) barthel <barthel@users.noreply.github.com> https://github.com/barthel
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

6. Attic

The directory _attic is the place where the old and not supported scripts will be moved into it. These scripts are not maintained anymore.

barthel / git-utils