ff-attic/tpquery
3
0
Fork 0
Code Issues 2 Pull requests Activity

Added readme.md

Browse source
This commit is contained in:
Willem 2015-06-19 19:18:16 +02:00
parent 6daddc6d2a
commit 3c3c70234b
5 changed files with 51 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -20,8 +20,6 @@ pom.xml.versionsBackup
# Ignore copyed site resource # Ignore copyed site resource
/src/site/markdown/build.md /src/site/markdown/build.md
/src/site/markdown/todo.md /src/site/markdown/todo.md
/src/site/markdown/versions.md
/src/site/markdown/authors.md
# Ignore binary files and formats # Ignore binary files and formats
*.o *.o

21
build.md
View file

@ -5,33 +5,34 @@
* java sdk 1.8 or higher. * java sdk 1.8 or higher.
* maven 3 or higher. * maven 3 or higher.
* Commands are runned in project root folder.
## Tests
### Run tests normal
mvn clean test
### Run tests with jacoco
mvn -Ptpquery-test-jacoco clean test
## Create build artifacts ## Create build artifacts
cd project-root/;
mvn -Ptpquery-build clean package; mvn -Ptpquery-build clean package;
## Change pom.xml versions ## Change pom.xml versions
cd project-root/;
mvn versions:set -DnewVersion=2.3.4-SNAPSHOT mvn versions:set -DnewVersion=2.3.4-SNAPSHOT
## Make release build ## Make release build
cd project-root/;
mvn -Ptpquery-build clean package; mvn -Ptpquery-build clean package;
mvn -B -Dusername=(scm_username) clean install release:clean release:prepare release:perform; mvn -B -Dusername=(scm_username) clean install release:clean release:prepare release:perform;
## Make site ## Make site
mvn -Ptpquery-test-jacoco clean test
mvn -Ptpquery-build-site site:site
cd project-root/;
mvn -Ptpquery-build-site clean install site:site
Optional add -DstagingDirectory=/tmp/tpquery-build-fullsite Optional add -DstagingDirectory=/tmp/tpquery-build-fullsite
And then manual upload. And then manual upload.
## Check for dependency-updates ## Check for dependency-updates
cd project-root/;
mvn versions:display-plugin-updates|grep ">"|uniq; mvn versions:display-plugin-updates|grep ">"|uniq;
mvn versions:display-dependency-updates|grep ">"|uniq; mvn versions:display-dependency-updates|grep ">"|uniq;

1
pom.xml
View file

@ -328,7 +328,6 @@
<configuration> <configuration>
<target> <target>
<echo>Copy project markdown to site.</echo> <echo>Copy project markdown to site.</echo>
<copy verbose="true" file="versions.md" todir="src/site/markdown" />
<copy verbose="true" file="todo.md" todir="src/site/markdown" /> <copy verbose="true" file="todo.md" todir="src/site/markdown" />
<copy verbose="true" file="build.md" todir="src/site/markdown" /> <copy verbose="true" file="build.md" todir="src/site/markdown" />
</target> </target>

40
readme.md Normal file
View file

@ -0,0 +1,40 @@
TPQuery
=========
TPQuery is a java8 library providing templated prepared statements.
## Installation
Add maven deps;
<dependency>
<groupId>net.forwardfire.tpquery</groupId>
<artifactId>tpquery-store</artifactId>
<version>x.x.x</version>
<scope>compile</scope>
</dependency>
## Files in this package
build.md - Developer build commands.
license.txt - The license of tpquery.
pom.xml - Maven specific build file.
readme.md - This file.
todo.md - Small todo list.
src - site source.
tpquery-executor-jdbc - Jdbc executor implementation.
tpquery-executor-jpa - JPA executor implementation.
tpquery-store - The query store library.
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Style and test your code.
## Release History
### Version x.x.0
* First public release
* Fourth rewrite of idea.

6
versions.md
View file

@ -1,6 +0,0 @@
# TPQuery versions
## Version x.x.0
* First public release
* Fourth rewrite of idea.