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-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
# Overview
2
-
3
-
Pk-vcs-git is [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) IVCS implementation for Git repositories.
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.
4
3
5
4
# Terms
6
5
- Workspace Home
@@ -48,7 +47,6 @@ Pk-vcs-git is [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) IVCS imp
48
47
- Use `vcs.setProxy()` and `vcs.setCredentials()` if neccessary
49
48
50
49
# Implementation details
51
-
52
50
-[JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
53
51
-[Github](https://github.com/) is used as hosting of a Test Repository
54
52
- LWC is obtained for each vcs operation.
@@ -57,10 +55,13 @@ Pk-vcs-git is [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) IVCS imp
57
55
- If `IVCS.setProxy()` is called then provided proxy is used to each url which contains `repoUrl`
58
56
59
57
# Functional testing
60
-
61
58
- Github is used for hosting the Test Repository
62
59
-[Kohsuke Github API](http://github-api.kohsuke.org/) is used to create and delete Test Repository
63
60
-`PK_VCS_TEST_GITHUB_USER` enviroment var or JVM var is used as username for access to Github
64
61
-`PK_VCS_TEST_GITHUB_PASS` enviroment var or JVM var is used as user password for access to Github
65
62
- New Test Repository is created before each test and deletes automatically after each test
66
63
- 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
64
+
- NOTE: Github has some latency for exposing results of previosly 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.
65
+
66
+
# Limitations
67
+
- Commit messages can not be atached to branch create and delete operations because Git does not exposes these operations as separate commits
0 commit comments