From 00934de9f750fb12e8e74007e8b21e56b03b044d Mon Sep 17 00:00:00 2001 From: Oli Dagenais Date: Sun, 27 Sep 2015 13:41:15 -0400 Subject: [PATCH 1/4] Downgrade checkstyle plugin 2.15 It's the last version that runs in Java 6. --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 2769ac3e..4234c7dc 100644 --- a/pom.xml +++ b/pom.xml @@ -106,7 +106,7 @@ Licensed under the MIT license. See License.txt in the project root. --> org.apache.maven.plugins maven-checkstyle-plugin - 2.16 + 2.15 verify-style From c8777c0b18fcb674c12dd93b94648f55e4f25d46 Mon Sep 17 00:00:00 2001 From: Oli Dagenais Date: Mon, 28 Sep 2015 07:59:39 -0400 Subject: [PATCH 2/4] Initial content for ReleaseNotes.md --- ReleaseNotes.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 ReleaseNotes.md diff --git a/ReleaseNotes.md b/ReleaseNotes.md new file mode 100644 index 00000000..96a52aa5 --- /dev/null +++ b/ReleaseNotes.md @@ -0,0 +1,7 @@ +Release Notes +============= +Every release is described here, from latest to earliest. + +Version 0.1.0 +------------- +Initial release of C# port which supports Basic authority only and a plain-text credential store (`~/insecureStore.xml`) making it equivalent to the built-in git-credential-store. From abce90c697ee4423e9d8c68e8813fe53eb419d30 Mon Sep 17 00:00:00 2001 From: Oli Dagenais Date: Mon, 28 Sep 2015 08:05:52 -0400 Subject: [PATCH 3/4] Include text files as resources in root of JAR --- pom.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/pom.xml b/pom.xml index 4234c7dc..8a2adc84 100644 --- a/pom.xml +++ b/pom.xml @@ -52,6 +52,17 @@ Licensed under the MIT license. See License.txt in the project root. --> + + + ${basedir} + ./ + + License.txt + ReadMe.md + ReleaseNotes.md + + + org.apache.maven.plugins From c33bacd794c46d0cd8c1e65b12670b394952c182 Mon Sep 17 00:00:00 2001 From: Oli Dagenais Date: Mon, 28 Sep 2015 16:03:34 -0400 Subject: [PATCH 4/4] Add preliminary installation instructions. --- Install.md | 42 ++++++++++++++++++++++++++++++++++++++++++ pom.xml | 1 + 2 files changed, 43 insertions(+) create mode 100644 Install.md diff --git a/Install.md b/Install.md new file mode 100644 index 00000000..a3c10732 --- /dev/null +++ b/Install.md @@ -0,0 +1,42 @@ +Installation Instructions +========================= +This document explains where to copy the JAR and how to configure Git to use the "Microsoft Git Credential Manager for Java" as its credential helper. + +System Requirements +------------------- +Great care was taken to avoid using any features of Java that would impact compatibility with Java 6. If you find a compatibility issue, please report it. +1. Java 6+ +2. Git 1.9+ + +How to install +-------------- +1. Copy the `git-credential-helper-0.1.0.jar` file somewhere safe and stable, such as `%APPDATA%/git-credential-helper/` on Windows or `~/Library/Application Support/git-credential-helper/` on Mac or `~/git-credential-helper/` on Linux. +2. Configure the `credential.helper` setting to launch Java with the path to the JAR (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt): + +```git config --global credential.helper '!java -jar path/to/git-credential-helper-0.1.0.jar'``` + +How to enable (or disable) debug mode +------------------------------------- +This will turn on tracing and assertions, producing a lot of output to `stderr`. Only turn this on temporarily, when trying to isolate a defect. +1. Retrieve the value of the `credential.helper` configuration: + + ```git config --global --get credential.helper``` + + ...it should look like this: + + ```!java -jar path/to/git-credential-helper-0.1.0.jar``` +2. Set a new value for the `credential.helper` configuration by inserting `-Ddebug=true` (or `-Ddebug=false` to disable) between `!java` and `-jar` (make sure you surround the whole value with 'single quotes' in Bash and "double quotes" in the Windows Command Prompt): + +```git config --global credential.helper '!java -Ddebug=true -jar path/to/git-credential-helper-0.1.0.jar'``` + +How to remove or uninstall +-------------------------- +We are sad to see you go! Please give us some feedback on how we could do better next time. +1. Retrieve the value of the `credential.helper` configuration: + + ```git config --global --get credential.helper``` +2. Delete the value of the `credential.helper` configuration: + + ```git config --global --unset credential.helper``` +3. The value retrieved in _step 1_ contained the path to the JAR. You can go delete that JAR. +4. Archive the `insecureStore.xml` file from your HOME folder. diff --git a/pom.xml b/pom.xml index 8a2adc84..4f9c1647 100644 --- a/pom.xml +++ b/pom.xml @@ -57,6 +57,7 @@ Licensed under the MIT license. See License.txt in the project root. --> ${basedir} ./ + Install.md License.txt ReadMe.md ReleaseNotes.md