SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added a section "Cloning the repository on Windows" for issue#1567 (#1575)

Browse Source 
* Added a section "Cloning the repository on Windows"

* Changes to incorporate feedback from Buzzardo

* Formatting as per feedback from Buzzardo

* removing bullet points.

* Presenting user with unnumbered list for git config options

* fixing a small typo

* adding code-fences and

Co-authored-by: Ankur Shukla <ashukla@thinkanalytics.com>

fixes gh-1567
This commit is contained in:
Ankur Shukla
2020-12-15 02:41:13 +05:30
committed by GitHub
parent ec909350e9
commit 82d0e6eb7a
1 changed files with 34 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/src/main/asciidoc/_building.adoc
View File

@@ -1,5 +1,38 @@
== How to Build Spring Cloud Contract
=== Cloning the repository on Windows
While cloning this project on Windows, some files in the git repository may exceed the Windows maximum file path limit of 255 characters, which may
result in an incorrectly (probably partially) checked out repository.
To resolve this issue, you can set the `core.longPaths` attribute to `true` or clone the Spring Cloud Contract repository.
To set the `core.longPaths` attribute to `true`, you have three options:
- Change it for all users of the machine (doing so requires administrator privileges):
[source,bash]
----
git config --system core.longPaths true
git clone https://github.com/spring-cloud/spring-cloud-contract.git
----
- Change it for the current user (no administrative privileges required):
[source,bash]
----
git config --global core.longPaths true
git clone https://github.com/spring-cloud/spring-cloud-contract.git
----
- Change for just this repository (administrative privileges depend on where the repository is being cloned to):
[source,bash]
----
git clone -c core.longPaths true https://github.com/spring-cloud/spring-cloud-contract.git
----
IMPORTANT: You need to have all the necessary Groovy plugins
installed for your IDE to properly resolve the sources. For example, in
Intellij IDEA, having both the Eclipse Groovy Compiler Plugin and the GMavenPlus Intellij
@@ -80,7 +113,7 @@ run the following command:
./scripts/parallelBuild.sh
```
To use eight 8 cores, run thke following command:
To use eight 8 cores, run the following command:
```
CORES=8 ./scripts/parallelBuild.sh