Merge git adsk 1.2.2

Author: Lars Schneider

README.md

@@ -2,7 +2,7 @@
 
 A painless Git setup with an easy way to share Git configs and scripts within a company using GitHub Enterprise or any similar on-premise Git hosting service.
 
-_Enterprise Config for Git_ adds a new Git setup command (e.g. `git mycompany`) to your Git config (via Git config alias) that configures a developer machine. The setup command checks the installed Git version, ensures Git LFS is installed properly, configures the user name and email based on the GitHub Enterprise profile, and configures the Git credential helper with a GitHub Enterprise token. It also adds an easy way to distribute company Git configs (e.g. [Git push protection](./config.include#L25-L35)) and Git helper scripts (e.g. [`git adsk clone`](./clone.sh)).
+_Enterprise Config for Git_ adds a new Git setup command (e.g. `git mycompany`) to your Git config (via Git config alias) that configures a developer machine. The setup command checks the installed Git version, ensures Git LFS is installed properly, configures the user name and email based on the GitHub Enterprise profile, and configures the Git credential helper with a GitHub Enterprise token. It also adds an easy way to distribute company Git configs (e.g. [Git push protection](./config.include#L25-L39)) and Git helper scripts (e.g. [`git adsk clone`](./clone.sh)).
 
 _Enterprise Config for Git_ supports Windows, Mac and Linux and a great number of shells such as BASH, ZSH, DASH, cmd.exe, and PowerShell.
 
@@ -11,12 +11,9 @@ Please find more details about _Enterprise Config for Git_ in the corresponding
 
 ## Getting Started
 
-In order to use _Enterprise Config for Git_ you need to fork it to your GitHub Enterprise instance and adjust it for your company:
-* Define the [name of the setup command](./config.include#L46) for your company
-* Set the [GitHub Enterprise server](./setup.sh#L8) (e.g. `github.mycompany.com`)
-* Set _Enterprise Config for Git_ [organization/repository of your fork](./setup.sh#L9) on your GitHub Enterprise server (e.g. `tools/enterprise-config`). Please ensure every engineer has read access.
-* Define your [contact in case of errors](./setup.sh#L16)
-* Register an [OAuth application](https://developer.github.com/v3/oauth/) on your GitHub Enterprise server and setup the _Enterprise Config for Git_ [client ID and secret](./setup.sh#L12-L13).
+In order to use _Enterprise Config for Git_ you need to fork it to your GitHub Enterprise instance (ensure that every engineer has read access) and adjust it for your company:
+* Define the [name of the setup command](./config.include#L51) for your company
+* Define your _Enterprise Config for Git_ [constants](./enterprise.constants)
 * Configure your desired [company email pattern](./lib/setup_helpers.sh#L84).
 * Create a production branch based on the master branch.
 

checkout.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+#
+# Checkout a branch and update submodules accordingly
+#
+# Usage: git <KIT_ID> checkout <branch>
+#
+set -e
+
+git checkout $@
+git submodule update --recursive

clone.sh

@@ -3,15 +3,8 @@
 # Clone Git repositories and download Git LFS files in parallel.
 # See more info here: https://github.com/github/git-lfs/issues/931
 #
-# Usage: git adsk clone <repository URL> [<target directory>]
+# Usage: git <KIT_ID> clone <repository URL> [<target directory>]
 #
 set -e
 
-git -c filter.lfs.smudge=cat clone --recursive $@
-if [[ -z $2 ]]; then
-    CLONE_PATH=$(basename ${1%.git});
-else
-    CLONE_PATH=$2;
-fi
-cd "$CLONE_PATH"
-git-lfs pull
+git-lfs clone --recursive $@

config.include

@@ -42,13 +42,14 @@
     st=status
     br=branch
     lol = "log --pretty=oneline --abbrev-commit --graph --decorate"
+    prlog = "log --pretty=oneline --abbrev-commit --graph --decorate --first-parent"
 
 
 ###############################################################################
 # Enterprise Config setup command
 ###############################################################################
     adsk = "!f() { \
-        KIT_PATH=$(dirname $(git config include.path)) && \
+        KIT_PATH=$(dirname \"$(git config include.path)\") && \
         COMMAND=$1 && \
         if [ -n \"$COMMAND\" ]; then \
             shift 1; \
@@ -58,6 +59,8 @@
             cp \"$KIT_PATH/setup.sh\" \"$TMP_SETUP\" && \
             bash \"$TMP_SETUP\" \"$KIT_PATH\" $@ && \
             rm \"$TMP_SETUP\"; \
+        elif [ \"$COMMAND\" = \"install\" ]; then \
+            echo \"Enterprise config already installed!\"; \
         elif [ -e \"$KIT_PATH/$COMMAND.sh\" ]; then \
             bash \"$KIT_PATH/$COMMAND.sh\" $@; \
         else \

enable-public-push.sh

@@ -3,10 +3,13 @@
 # Override the Enterprise Config push protection feature configure in
 # config.include.
 #
-# Usage: git adsk enable-public-push <server/org/repo>
+# Usage: git <KIT_ID> enable-public-push <server/org/repo>
 #
 set -e
 
+KIT_PATH=$(dirname "$0")
+. "$KIT_PATH/enterprise.constants"
+
 REPO=$1
 git config --global url.https://$REPO.pushInsteadOf https://$REPO
 git config --global url.git@$REPO.pushInsteadOf git@$REPO
@@ -16,7 +19,6 @@ git config --global url.git@$REPO.pushInsteadOf git@$REPO
 ### Enterprise Config
 ###
 
-Git push to public repo on "$REPO" enabled. Be careful and please respect the source code policy!
+Git push to public repo on "$REPO" enabled. Be careful and please respect the source code policy: $KIT_SOURCE_CODE_POLICY_URL
 
 EOM
-

enterprise.constants

@@ -0,0 +1,32 @@
+###############################################################################
+# Configure these variables. See README.md for details.
+###############################################################################
+
+# Define the name of the setup command for your company
+# Attention: This must match the alias defined in config.include!
+KIT_ID='adsk'
+
+# Define your GitHub Enterprise server
+GITHUB_SERVER='git.yourcompany.com'
+
+# Define the path of this repo on your GitHub Enterprise server
+KIT_ORG_REPO='yourorg/enterprise-config-for-git'
+
+# Register an OAuth application on your GitHub Enterprise server:
+# https://developer.github.com/v3/oauth/
+KIT_CLIENT_ID=<< YOUR OAUTH CLIENT ID >>
+KIT_CLIENT_SECRET=<< YOUR OAUTH SECRET >>
+
+# Define the link to your source code policy
+KIT_SOURCE_CODE_POLICY_URL=https://yourcompany.com/policy
+
+# Define a message for the users in case of errors
+ERROR_HELP_MESSAGE="Please contact [email protected]!"
+
+
+###############################################################################
+# No changes beyond this point
+###############################################################################
+
+KIT_TESTFILE="https://$GITHUB_SERVER/raw/$KIT_ORG_REPO/master/README.md"
+KIT_REMOTE_URL="https://$GITHUB_SERVER/$KIT_ORG_REPO.git"

help.sh

@@ -2,36 +2,52 @@
 #
 set -e
 
+KIT_PATH=$(dirname "$0")
+. "$KIT_PATH/enterprise.constants"
+
+# Infer a github url from a remote url
+INFO_URL=${KIT_REMOTE_URL%%.git}
+INFO_URL=${INFO_URL/#git@/https:\/\/}
+
 read -r -d '\0' HELP <<EOM
 ###
 ### Enterprise Config
 ###
 
 # Setup
 Description: Configures your machine to use Git.
-Command:     git adsk
+Command:     git $KIT_ID
 
 # Teardown
 Description: Removes all Git credentials from your machine.
-Command:     git adsk teardown
+Command:     git $KIT_ID teardown
 
 # Clone
 Description: Fast clone a repository with Git LFS files and submodules.
-Command:     git adsk clone <repository URL> [<target directory>]
+Command:     git $KIT_ID clone <repository URL> [<target directory>]
 
 # Pull
 Description: Pull changes from a repository and all its submodules.
-Command:     git adsk pull
+Command:     git $KIT_ID pull
+
+# Deleted
+Description: list the files that have been deleted from the current repository
+Command:    git adsk show-deleted [-h] [<path/to/file>]
+Example:    git adsk show-deleted
 
 # Help
 Description: This help page.
-Command:     git adsk help
+Command:     git $KIT_ID help
 
 # Version
 Description: Print version information.
-Command:     git adsk version
+Command:     git $KIT_ID version
 
+---
+You can easily add your own commands. See $INFO_URL for details.
+
+If you run into any trouble:
+$ERROR_HELP_MESSAGE
 \0
 EOM
 echo "$HELP"
-

lib/lnx/find_pfx.pl

@@ -0,0 +1,18 @@
+#!/usr/bin/env perl
+
+# We don't want the plumbing directory.
+# We would like to see what the user would when
+# typing `which git`
+
+use 5.016;
+use warnings;
+use File::Basename;
+
+for my $dir ( split( /:/, $ENV{'PATH'} ) ) {
+    next if ( $dir =~ /git-core/ );
+    if ( -f "$dir/git" ) {
+        print "$dir\n";
+        exit(0);
+    }
+}
+die "git not found in " . $ENV{'PATH'} . "\n";

lib/lnx/setup_helpers.sh

@@ -10,7 +10,7 @@ function credential_helper_parameters {
 function install_git_lfs {
     local KIT_PATH=$1
     local VERSION=$2
-    local GIT_LFS_CHECKSUM="578a3b9c44edcadc7e9e32a576910d6f"
+    local GIT_LFS_CHECKSUM="aba77a55638502b4d58cad5c52bfdf98"
     # Run this to calculate the hash for a new version:
     # export V="1.1.1"; curl --location https://github.com/github/git-lfs/releases/download/v$V/git-lfs-linux-amd64-$V.tar.gz | md5
 
@@ -25,21 +25,18 @@ function install_git_lfs {
         error_exit "Failed to extract the contents of Git-LFS archive ($SRC_URL)"
     fi
 
+    chmod -R 775 $EXTRACT_FOLDER
     for f in $(ls "$EXTRACT_FOLDER/"); do
-        if [[ -x "$EXTRACT_FOLDER/$f/install.sh" ]]; then
-            local PFX=$(dirname $(dirname $(which git)))
-            if ( has_command git-lfs ); then
-                # reuse existing install folder if this is an update
-                PFX=$(dirname $(dirname $(which git-lfs)))
-            fi
-            echo "Installing git-lfs to $PFX, please supply credentials if prompted."
-            if ! (cd "$EXTRACT_FOLDER/$f"; sudo PREFIX=$PFX "$EXTRACT_FOLDER/$f/install.sh"); then
-                rm -f "$DOWNLOAD_FILE"
-                rm -rf "$EXTRACT_FOLDER"
-                error_exit "Failed to execute the Git-LFS installation script"
-            fi
-            break
+        local PFX="/usr/bin"
+        if ( has_command git-lfs ); then
+            # reuse existing install folder if this is an update
+            PFX=$(dirname $(which git-lfs))
+        else
+            PFX=$(perl "$KIT_PATH/lib/lnx/find_pfx.pl")
         fi
+        chmod 755 "$EXTRACT_FOLDER/$f/git-lfs"
+        sudo cp "$EXTRACT_FOLDER/$f/git-lfs" $PFX
+        sudo chmod 755 $PFX/git-lfs
     done
 
     if [[ -e $DOWNLOAD_FILE ]]; then

lib/osx/setup_helpers.sh

@@ -14,7 +14,7 @@ function _macports_has_port() {
 
 function _managerless_lfs_install() {
     local VERSION=$1
-    local GIT_LFS_CHECKSUM=2e43480adbd3694b756c95558ecdf5cf
+    local GIT_LFS_CHECKSUM=06d82272deabbc0bf9642868170fa7dd
     # Run this to calculate the hash for a new version:
     # export V="1.1.1"; curl --location https://github.com/github/git-lfs/releases/download/v$V/git-lfs-darwin-amd64-$V.tar.gz | md5
 
@@ -45,7 +45,7 @@ function _managerless_lfs_install() {
                 PFX=/usr/local
             fi
             echo "Installing git-lfs to $PFX, please supply credentials if prompted."
-            if ! (cd "$EXTRACT_FOLDER/$f"; sudo PREFIX=$PFX "$EXTRACT_FOLDER/$f/install.sh"); then
+            if ! (cd "$EXTRACT_FOLDER/$f"; sudo env PREFIX=$PFX "$EXTRACT_FOLDER/$f/install.sh"); then
                 rm -f "$DOWNLOAD_FILE"
                 rm -rf "$EXTRACT_FOLDER"
                 error_exit "Failed to execute the Git-LFS installation script"