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
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
Pk-vcs-git is lightweight library for execute basic Git VCS operations (merge, branch create etc). It uses [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) exposing IVCS implementation for Git repositories and [JGit](https://eclipse.org/jgit/) as framework to work with Git repositories.
3
3
Features:
4
4
- Branch create and remove
5
-
- Branch merge returning result(success or list of conflicted files)
6
-
-Commit messages list
5
+
- Branch merge returning result(success or list of conflicted files)
6
+
-Branch commits messages list
7
7
- Summarized branch changes list
8
8
- Branches list
9
9
- File content getting and setting
@@ -54,6 +54,7 @@ Features:
54
54
```
55
55
- Use methods of `IVCS` interface. See [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) for details
56
56
- Use `vcs.setProxy()` and `vcs.setCredentials()` if necessary
57
+
- Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. Use `GitVCS.setExpectedLatency()` to set delay which will be executed after each operation which may have server latency
57
58
58
59
# Implementation details
59
60
-[JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
@@ -70,7 +71,7 @@ Features:
70
71
-`PK_VCS_TEST_GITHUB_PASS` environment var or JVM var is used as user password for access to Github
71
72
- New Test Repository is created before each test and deletes automatically after each test
72
73
- To execute tests just run GitVCSTest class as JUnit test. Tests from VCSAbstractTest class will be executed. See [pk-vcs-test](https://github.com/ProjectKaiser/pk-vcs-test) for details
73
-
- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. Need to wait a couple of second to get new list. So if a test failed then try to execute it again.
74
+
- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. 2 seconds awaiting is added for testing. Also if a test failed then try to execute it again.
74
75
75
76
# Limitations
76
77
- Commit messages can not be attached to branch create and delete operations because Git does not exposes these operations as separate commits
0 commit comments