Skip to content

Commit 087cd08

Browse files
author
gdy
committed
documentation updated
1 parent 0cc7742 commit 087cd08

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ Features:
2020
- Folder where vcs-related operations are executed. Provides thread- and process-safe repository of working folders. See [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) for details
2121
- Test Repository
2222
- Git repository which is used to execute functional tests
23-
- Hosted on [Github](https://github.com/) using username and password provided by environment variables (see below)
23+
- File-based repository is used
2424
- Generates new before and deletes after each test
2525
- Named randomly (uuid is used)
26-
- [Kohsuke Github API](http://github-api.kohsuke.org/) is used as to operate with Github API
2726

2827
# Using pk-vcs-git
2928
- Add github-hosted pk-vcs-git project as maven dependency using [jitpack.io](https://jitpack.io/). As an example, add following to gradle.build file:
@@ -68,12 +67,9 @@ Features:
6867
- If `IVCS.setProxy()` is called then provided proxy is used for each url which contains `repoUrl`
6968

7069
# Functional testing
71-
- Github is used for hosting the Test Repository
72-
- [Kohsuke Github API](http://github-api.kohsuke.org/) is used to create and delete Test Repository
73-
- `PK_VCS_TEST_GITHUB_USER` environment var or JVM var is used as username for access to Github
74-
- `PK_VCS_TEST_GITHUB_PASS` environment var or JVM var is used as user password for access to Github
75-
- New Test Repository is created before each test and deletes automatically after each test
70+
- New local file-based Test Repository is created before each test and deletes automatically after each test
7671
- 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
72+
- Run `gradle test` to execute tests
7773

7874
# Limitations
7975
- 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

Comments
 (0)