Skip to content

Commit 0462822

Browse files
authored
Update README.md
1 parent 6efb486 commit 0462822

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# 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.
43

54
# Terms
65
- Workspace Home
@@ -48,7 +47,6 @@ Pk-vcs-git is [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) IVCS imp
4847
- Use `vcs.setProxy()` and `vcs.setCredentials()` if neccessary
4948

5049
# Implementation details
51-
5250
- [JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
5351
- [Github](https://github.com/) is used as hosting of a Test Repository
5452
- 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
5755
- If `IVCS.setProxy()` is called then provided proxy is used to each url which contains `repoUrl`
5856

5957
# Functional testing
60-
6158
- Github is used for hosting the Test Repository
6259
- [Kohsuke Github API](http://github-api.kohsuke.org/) is used to create and delete Test Repository
6360
- `PK_VCS_TEST_GITHUB_USER` enviroment var or JVM var is used as username for access to Github
6461
- `PK_VCS_TEST_GITHUB_PASS` enviroment var or JVM var is used as user password for access to Github
6562
- New Test Repository is created before each test and deletes automatically after each test
6663
- 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

Comments
 (0)