|
1 |
| -[](https://jitpack.io/#scm4j/scm4j-vcs-svn) |
| 1 | +[](https://jitpack.io/#scm4j/scm4j-vcs-svn) |
| 2 | +[](https://travis-ci.org/scm4j/scm4j-vcs-svn) |
| 3 | +[](https://coveralls.io/github/scm4j/scm4j-vcs-svn?branch=master) |
2 | 4 |
|
3 | 5 | # Overview
|
4 | 6 | scm4j-vcs-svn is lightweight library for execute basic SVN VCS operations (merge, branch create etc). It uses [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) exposing IVCS implementation for SVN repositories and [SVNKit](https://svnkit.com/) as framework to work with SVN repositories.
|
@@ -38,22 +40,14 @@ Features:
|
38 | 40 | }
|
39 | 41 | ```
|
40 | 42 | Or download release jars from https://github.com/scm4j/scm4j-vcs-svn/releases
|
41 |
| -- Create Workspace Home instance providing path to any folder as Workspace Home folder path. This folder will contain repositories folders (if different vcs or repositories are used) |
42 |
| -```java |
| 43 | +- Code snippet |
| 44 | + ```java |
43 | 45 | public static final String WORKSPACE_DIR = System.getProperty("java.io.tmpdir") + "svn-workspaces";
|
44 |
| - ... |
45 | 46 | IVCSWorkspace workspace = new VCSWorkspace(WORKSPACE_DIR);
|
46 |
| - ... |
47 |
| -``` |
48 |
| -- Obtain Repository Workspace from Workspace Home providing a certain Repository's url. The obtained Repository Workspace will represent a folder within Workspace Home dir which will contain all Working Copies relating to the provided VCS Repository |
49 |
| -```java |
50 | 47 | String repoUrl = "https://github.com/MyUser/MyRepo";
|
51 | 48 | IVCSRepositoryWorkspace repoWorkspace = workspace.getVCSRepositoryWorkspace(repoUrl);
|
52 |
| -``` |
53 |
| -- Create `SVNVCS` instance providing Repository Workspace, username and password for Repository |
54 |
| -```java |
55 |
| - IVCS vcs = new SVNVCS(repoWorkspace, username, pass); |
56 |
| -``` |
| 49 | + IVCS vcs = new SVNVCS(repoWorkspace, "username", "pass"); |
| 50 | + ``` |
57 | 51 | - Use methods of `IVCS` interface. See [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) for details
|
58 | 52 | - Use `vcs.setProxy()` and `vcs.setCredentials()` if necessary
|
59 | 53 |
|
|
0 commit comments