diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8839bab --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +target/ + +release.properties + +.idea/ +*.iml diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..282720f --- /dev/null +++ b/README.adoc @@ -0,0 +1,40 @@ += Narayana Checkstyle Configuration + +This repository contains the checkstyle rules used by some narayana projects. + +== How to build + +Compile with Maven. + +[source,bash] +---- +mvn clean install +---- + +== How to release + +Release is performed to https://repository.jboss.org/nexus/[JBoss Nexus]. + +Credentials for release needs to be setup in the `~/.m2/settings.xml` (or settings defined with `-s` parameter) +where you link the repository id `jboss-releases-repository` with the username/password. + +```xml + + jboss-releases-repository + [username] + [password for jboss nexus connection] + +``` + +As the next step run the `mvn release` and proceed standard +http://maven.apache.org/maven-release/maven-release-plugin/usage.html[steps for maven release plugin]. + +* `git checkout master; git fetch upstream master; git rebase upstream/master; git push upstream master` +* `mvn javadoc:javadoc` - verification that there won't be any javadoc errors during `release:perform` + +* `mvn release:clean` +* `mvn release:prepare` +* `mvn release:perform` + +Dry run: `mvn release:prepare -DdryRun=true` + diff --git a/README.md b/README.md deleted file mode 100644 index 937ab53..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -This repository contains the checkstyle rules used by some narayana projects. diff --git a/pom.xml b/pom.xml index aa16a6a..6b1e8cd 100644 --- a/pom.xml +++ b/pom.xml @@ -16,11 +16,23 @@ 1.0.0.Final-SNAPSHOT - - - LGPL 2.1 - http://www.gnu.org/licenses/lgpl-2.1.html - - + + LGPL 2.1 + http://www.gnu.org/licenses/lgpl-2.1.html + + + + + jboss-releases-repository + JBoss Release Repository + https://repository.jboss.org/nexus/service/local/staging/deploy/maven2/ + + + + scm:git:https://github.com/jbosstm/narayana-checkstyle-config.git + https://github.com/jbosstm/narayana-checkstyle-config + scm:git:https://github.com/jbosstm/narayana-checkstyle-config.git + HEAD +