Merge pull request #13 from hfagerlund/feature/automate-installation

Add installation script

Author: hfagerlund

Makefile

@@ -0,0 +1,46 @@
+# author: Heini Fagerlund
+# license: MIT
+#
+# Copyright (c) 2018 Heini Fagerlund
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+SHELL = /bin/sh
+
+MAIN_FILE     = git-add-msg
+AUX_FILES     = git-add-msg-config_sample.cfg
+AUX_FILES    += git-add-msg-trac-service
+
+.PHONY: all check-var
+
+all:
+	@echo "usage: make [install DEST_DIR=<path-to-git-extensions-directory>]"
+
+check-var:
+ifndef DEST_DIR
+	$(error Error: DEST_DIR is not set. For usage, run 'make')
+endif
+
+install: check-var
+	$(info > Installing git-add-msg to directory: '$(DEST_DIR)':)
+	@install -d -m 0755 $(DEST_DIR)
+	@install -m 0755 $(MAIN_FILE) $(DEST_DIR)
+	@install -m 0644 $(AUX_FILES) $(DEST_DIR)
+	@ls -1 $(DEST_DIR)
+	@echo "> Installation completed."

README.md

@@ -3,16 +3,12 @@ A git extension (command line tool) that automatically logs commits to Trac and/
 
 Replaces the following commands:
 ```
-$ git add .
+$ git add -A
 ```
 and: 
 ```
 $ git commit -am "<insert-your-commit-message-here>"
 ```
-and (optionally): 
-```
-$ git status
-```
 Also creates a **changelog.log** file (in your project's root directory), and (optionally) adds a comment in the Trac ticket for each commit.
 
 ## tl;dr
@@ -33,30 +29,36 @@ $ git add-msg
 (All copyrights for the above remain with their respective owners.)
 - - -
 ## Installation
-### Download:
-Download the **git-add-msg** project in [.zip](https://github.com/hfagerlund/git-add-msg/archive/master.zip) format, or clone the repository:
 ```
 $ git clone https://github.com/hfagerlund/git-add-msg.git
+$ cd git-add-msg
+$ make install DEST_DIR=/path/to/your-git-extensions-directory
 ```
-
-
-Place the (extracted) **git-add-msg**, **trac-service**, and **config_sample.cfg** files in ``<your-git-extensions-directory>``, and add it to your (executable) path:
+* add the path to `<your-git-extensions-directory>` to your **executable path**:
 ```bash
-export PATH="$PATH:/path/to/<your-git-extensions-directory>" #Note: no trailing slash
+export PATH="$PATH:/path/to/your-git-extensions-directory" #Note: no trailing slash
 ```
 
+### To uninstall:
+Manually remove the following files from `<your-git-extensions-directory>`:
+```
+git-add-msg-config.cfg
+git-add-msg-config_sample.cfg
+git-add-msg
+git-add-msg-trac-service
+```
 - - -
 ## Configuration
 #### All users:
-(OPTIONAL) Copy and save ``config_sample.cfg`` as ``config.cfg``. This step can be skipped (refer to note below).
+(OPTIONAL) Rename ``git-add-msg-config_sample.cfg`` to ``git-add-msg-config.cfg`` in `<your-git-extensions-directory>`. This step can be skipped (refer to note below).
 
-**Note**: if a ``config.cfg`` file is **not** present, it will result in a warning message being displayed when the tool is run (this can be safely ignored).
+**Note**: if a ``git-add-msg-config.cfg`` file is **not** present, it will result in a warning message being displayed when the tool is run (this can be safely ignored if not using Trac).
 
 - - - 
 #### Trac users only:
-(1.) Update ``config.cfg`` (copied from ``config_sample.cfg``) with your Trac settings by replacing the following values:
+(1.) Update ``git-add-msg-config.cfg`` (copied from ``git-add-msg-config_sample.cfg`` in `<your-git-extensions-directory>`) with your Trac settings by replacing the following values:
 ```
-repo="no_repo_specified"         # replace <no_repo_specified> with the name of your Trac repository
+repo="no_repo_specified"         # replace <no_repo_specified> with the **name** of your Trac repository (found in Trac under 'Administration' > 'Manage Repositories' > 'Name')
 username="no_username_specified" # (as above, but with your Trac login username)
 password="no_password_specified" 
 host="no_host_specified"
@@ -92,11 +94,6 @@ git committing...
 [master e10379d] #221: updated content
  1 files changed, 1 insertions(+), 0 deletions(-)
 Trac ticket successfully updated.
-Do you wish to view the git status?
-	 Yes (y)
-	 No (n)
-## selected 'n'
-Exiting.
 ```
 
 #### Trac users:
@@ -121,6 +118,7 @@ Copyright (c) 2015 Heini Fagerlund. Licensed under the [MIT license](http://open
 
 - - -
 ## Changelog
+* 0.3.1 - January 29, 2018. New feature: automated installation.
 * 0.2.1 - January 29, 2018. Fixed display of changeset number in auto-generated Trac link.
 * 0.2.0 - January 13, 2016. Deprecated (optional) git status check.
 * 0.1.4 - December 30, 2015. Fixed display of ticket update message.

git-add-msg

@@ -2,19 +2,18 @@
 # A git extension (command line tool) that automatically logs commits to Trac and/or a changelog.
 # 
 ## ie. is a substitute for the following commands:
-##               $ git add .
+##               $ git add -A
 ##               $ git commit -am "<place your commit msg here>"
-## (optionally)  $ git status
 #
-# Also creates file 'changelog.txt' (ie. logs git SHA-1 hashes/changesets).
+# Also creates file 'changelog.log' (ie. logs git SHA-1 hashes/changesets).
 #
 # Usage:
 # * make executable using: $ chmod 0750 git-add-msg
 # * (all users) run using: $ git add-msg
 # * (Trac users) run using -r option to automatically add comments, with links to changesets in specified repository, in Trac tickets.
 #
 # author: Heini Fagerlund
-# version: 0.2.1
+# version: 0.3.1
 # license: MIT
 # 
 # Copyright (c) 2015 Heini Fagerlund
@@ -50,7 +49,7 @@ _key()
 usage() { 
     printf "\t%s\n" "$bar"
 
-    printf "\t %s\n" "USAGE:  ./trac-service [-r <string>]
+    printf "\t %s\n" "USAGE:  ./git-add-msg-trac-service [-r <string>]
                    options:  
                    -r    Trac repository name"
     printf "\t%s\n" "$bar" 
@@ -66,14 +65,14 @@ while getopts ":r:" option; do
     esac
 done
 
-if [ -f $currentDir/config.cfg ];
+if [ -f $currentDir/git-add-msg-config.cfg ];
 then
-    sed -i "s/^\(repo=\).*$/\1\"$rarg\"/" $currentDir/config.cfg
+    sed -i "s/^\(repo=\).*$/\1\"$rarg\"/" $currentDir/git-add-msg-config.cfg
     repo=${rarg:-no_repo_specified}
 else
     printf "\t%s\n" "$bar"
     printf "ALL USERS:\nTo avoid seeing this message again,
-copy and save config_sample.cfg as config.cfg.\n\nTrac USERS ONLY:\nUpdate config.cfg with your Trac settings.\n"
+copy and save git-add-msg-config_sample.cfg as git-add-msg-config.cfg.\n\nTrac USERS ONLY:\nUpdate git-add-msg-config.cfg with your Trac settings.\n"
     printf "\t%s\n" "$bar"
     exit
 fi
@@ -88,7 +87,7 @@ do
 
     if [ ! -z "$mymultimsg" -a "$mymultimsg" != " " ]; then
         printf "git committing...\n"
-        git add .
+        git add -A
 	git commit -am "#$ticketnum: $mymultimsg" | xclip
         changeset=$( xclip -o ) 
 
@@ -141,7 +140,7 @@ MYXML
  </xsl:template>
 </xsl:stylesheet> 
 EOF
-		    . trac-service
+		    . git-add-msg-trac-service
 
 		else
 		    rm -r ./bin/

config_sample.cfg git-add-msg-config_sample.cfgconfig_sample.cfg renamed to git-add-msg-config_sample.cfg

@@ -1,15 +1,15 @@
 # configuration file - integrates add-msg git extension with Trac
-# 
+#
 # Replace the values for all variables with your Trac settings,
-# and save this file as 'config.cfg'.
+# and save this file as 'git-add-msg-config.cfg'.
 #
-# Run the following command to help secure this file: 
-# $ chmod 0600 config.cfg
+# Run the following command to help secure this file:
+# $ chmod 0600 git-add-msg-config.cfg
 
 #Trac configuration:
 repo="no_repo_specified"         # name of repository
 username="no_username_specified" # login username
 password="no_password_specified" # login password
 host="no_host_specified"         # Trac host (name or IP address)
-port="no_port_specified"         # Trac port number 
+port="no_port_specified"         # Trac port number
 instance="no_instance_specified" # Trac instance name

trac-service git-add-msg-trac-servicetrac-service renamed to git-add-msg-trac-service

@@ -3,26 +3,26 @@
 # Use with git-add-msg to log git commits to Trac using its XML-RPC API
 #
 # author: Heini Fagerlund
-# version: 0.2.1
+# version: 0.3.1
 # license: MIT
-#	
+#
 # The MIT License (MIT)
 # [OSI Approved License]
-# 
+#
 # The MIT License (MIT)
-# 
+#
 # Copyright (c) 2015 Heini Fagerlund
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -33,17 +33,17 @@
 
 
 #Trac configuration
-. $currentDir/config.cfg
+. $currentDir/git-add-msg-config.cfg
 
 #populate result.xml with commit msg as comment
 xsltproc --output bin/result.xml bin/transform.xsl bin/body_template.xml
-  
+
 if curl -H 'Content-Type: application/xml' --data @bin/result.xml "http://$username:$password@$host:$port/$instance/login/xmlrpc" &> /dev/null
   then printf "Trac ticket successfully updated.\n"
 else
-    printf "\t%s\n" "$bar" 
-    printf "WARNING: Trac ticket could not be updated.\nAre the Trac settings in config.cfg up-to-date? 
+    printf "\t%s\n" "$bar"
+    printf "WARNING: Trac ticket could not be updated.\nAre the Trac settings in git-add-msg-config.cfg up-to-date?
 If so, please check whether Trac is running, and try again.\n\nIf you are not using Trac, please disregard this message.\n\n"
-    printf "\t%s\n" "$bar" 
+    printf "\t%s\n" "$bar"
 fi
 rm -r ./bin/