Skip to content

Commit ebcdeec

Browse files
committed
Update documentation for #12
1 parent 0b2284d commit ebcdeec

File tree

3 files changed

+25
-28
lines changed

3 files changed

+25
-28
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,50 +31,45 @@ You have to be a fully utPLSQL environment available compatible with the Java AP
3131

3232
* `paths`
3333
* Paths of the resources
34+
35+
* `sources`
36+
* Path to project source files
3437
* `sourcesRegexExpression`
35-
*
38+
* utPLSQL will convert file paths into database objects using the following regular expression
3639
* `sourcesOwnerSubexpression`
37-
*
40+
* Object owner is identified by the expression with the specified set of brackets
3841
* `sourcesNameSubexpression`
39-
*
42+
* Object name is identified by the expression with the specified set of brackets
4043
* `sourcesTypeSubexpression`
41-
*
44+
* Object Type is identified by the expression with the specified set of brackets
4245

4346
* `tests`
44-
* Test fo the scripts at the style of the maven resources
47+
* Path to project test files
4548
* `testsRegexExpression`
46-
*
49+
* utPLSQL will convert file paths into database objects using the following regular expression
4750
* `testsOwnerSubexpression`
48-
*
51+
* Owner is identified by the expression with the specified set of brackets
4952
* `testsNameSubexpression`
50-
*
53+
* Object name is identified by the expression with the specified set of brackets
5154
* `testsTypeSubexpression`
52-
53-
* `targetDir`
54-
* Target dir, this is a readonly property
55-
* Default: `${project.build.directory}`
56-
* `includeObject`
57-
* Include Object
58-
* `excludeObject`
59-
* Exclude Objects
55+
* Object Type is identified by the expression with the specified set of brackets
6056

6157

6258

6359
### Sample of use
6460
The next snippet is a sample of declaration of the pom
6561
```xml
66-
<plugin>
62+
<plugin>
6763
<groupId>org.utplsql</groupId>
6864
<artifactId>utplsql-maven-plugin</artifactId>
6965
<version>1.0.0-SNAPSHOT</version>
70-
<goals>
71-
<goal>test</goal>
72-
</goals>
73-
<configuration>
66+
<goals>
67+
<goal>test</goal>
68+
</goals>
69+
<configuration>
7470
<dbUrl>url_of_connection</dbUrl>
7571
<dbUser>user</dbUser>
7672
<dbPass>password</dbPass>
77-
<version>3.1.0</version>
7873
<failOnErrors>false</failOnErrors>
7974
<reporters>
8075
<reporter>
@@ -109,6 +104,10 @@ The next snippet is a sample of declaration of the pom
109104
</includes>
110105
</test>
111106
</tests>
112-
</configuration>
113-
</plugin>
107+
</configuration>
108+
</plugin>
114109
```
110+
111+
More project samples are available in the src/test/resources directory :
112+
* simple-project : minimalist test project with standard project directory structure
113+
* regex-project : override project directory structure and use additional parameters (sourcesRegexExpression, testsRegexExpression, ...) to tell utPLSQL how the project files are to be mapped into database objects.

pom.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99

1010
<name>utplsql-maven-plugin Maven Plugin Build</name>
1111

12-
<!-- FIXME change it to the project's website -->
13-
<url>http://maven.apache.org</url>
12+
<url>https://github.com/utPLSQL/utPLSQL-maven-plugin</url>
1413

1514
<properties>
1615
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

utplsql-maven-plugin/pom.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010

1111
<name>utplsql-maven-plugin Maven Plugin</name>
1212

13-
<!-- FIXME change it to the project's website -->
14-
<url>http://maven.apache.org</url>
13+
<url>https://github.com/utPLSQL/utPLSQL-maven-plugin</url>
1514

1615
<properties>
1716
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

0 commit comments

Comments
 (0)