You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Use cases
26
26
# Terms
27
27
- Workspace Home
28
28
- Home local folder of all folders used by vcs-related operations. See [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) for details
29
-
- Locked Working Copy,
29
+
- Locked Working Copy, LWC
30
30
- Local folder where vcs-related operations are executed. Provides thread- and process-safe repository of working folders. See [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) for details
31
31
- Test Repository
32
32
- Git repository which is used to execute functional tests
@@ -51,7 +51,7 @@ Use cases
51
51
Or download release jars from https://github.com/scm4j/scm4j-vcs-git/releases
52
52
- Code snippet
53
53
```java
54
-
public static final String WORKSPACE_DIR = System.getProperty("java.io.tmpdir") + "git-workspaces";
54
+
final String WORKSPACE_DIR = System.getProperty("java.io.tmpdir") + "git-workspaces";
55
55
IVCSWorkspace workspace = new VCSWorkspace(WORKSPACE_DIR);
-[JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
67
67
- Each vcs operation is executed within a LWC
68
68
-`getLocalGit(IVCSLockedWorkingCopy wc)` method is used to create a Git implementation to execute vcs operations within `wc` Working Copy
69
-
- If provided LWC is empty then current Test Repository is cloned into this LWC, otherwise existing repository is just switched to required branch
69
+
- If provided LWC is empty then current Test Repository is cloned into this LWC, otherwise existing repository is just switched to the required branch
70
70
- If `IVCS.setProxy()` is called then provided proxy is used for each url which contains `repoUrl`
71
71
72
72
# Functional testing
73
73
- New local file-based Test Repository is created before each test and deletes automatically after each test
74
74
- To execute tests just run GitVCSTest class as JUnit test. Tests from VCSAbstractTest class will be executed. See [scm4j-vcs-test](https://github.com/scm4j/scm4j-vcs-test) for details
75
-
-Run`gradle test` to execute tests
75
+
-Or run`gradle test` to execute tests
76
76
77
77
# Limitations
78
-
- Commit messages can not be attached to branch create and delete operations because Git does not exposes these operations as separate commits
78
+
- Commit messages can not be attached to branch create and delete operations because Git does not expose these operations as separate commits
0 commit comments