Skip to content

Commit 953ba13

Browse files
committed
documentation update
1 parent 606b8a4 commit 953ba13

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ scm4j-vcs-api provides:
3838
- The latest commit or state of a branch
3939
- Master Branch
4040
- "Master" for Git, "Trunk" for SVN etc
41+
- `VCSTag`, Tag
42+
- Contains tag name, tag log message, tag author and `VCSCommit` instance which represents the tagged commit
4143

4244
# Using VCS interface
4345
IVCS interface consists of few basic vcs functions.
@@ -91,6 +93,12 @@ Note: null passed as a branch name is considered as Master Branch. Any non-null
9193
- Returns `VCSCommit` instance pointing to the head (last) commit of the branch `branchName`
9294
- `Boolean fileExists(String branchName, String filePath)`
9395
- Returns true if the file with path `filePath` exists in repository in branch `branchName`, false otherwise
96+
- `VCSTag createTag(String branchName, String tagName, String tagMessage) throws EVCSTagExists`
97+
- Creates a tag named `tagName` with log message `tagMessage` on a Head of branch `branchName`
98+
- `List<VCSTag> getTags()`
99+
- Returns list of all tags
100+
- `VCSTag getLastTag()`
101+
- Returns the last created tag
94102

95103
# Using Locked Working Copy
96104
Let's assume we developing a multiuser server which has ability to merge branches of user's repositories. So few users could request to merge theirs branches of different repositories simultaneously. For example, Git merge operation consists of few underlying operations (check in\out, merge itself, push) which must be executed on a local file system in a certain folder. So we have following requirements:

0 commit comments

Comments
 (0)