add README
Project: http://git-wip-us.apache.org/repos/asf/maven-scm/repo Commit: http://git-wip-us.apache.org/repos/asf/maven-scm/commit/83213001 Tree: http://git-wip-us.apache.org/repos/asf/maven-scm/tree/83213001 Diff: http://git-wip-us.apache.org/repos/asf/maven-scm/diff/83213001 Branch: refs/heads/master Commit: 83213001d1a72b78f72c2af35683734da1a47d4d Parents: 2fe3d6b Author: imod <d...@fortysix.ch> Authored: Fri Jun 21 21:09:09 2013 +0200 Committer: imod <d...@fortysix.ch> Committed: Fri Jun 21 21:09:09 2013 +0200 ---------------------------------------------------------------------- README.md | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven-scm/blob/83213001/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b891b7 --- /dev/null +++ b/README.md @@ -0,0 +1,101 @@ +maven-scm-provider-jgit +=== + +This scm provider implementation allows the usage of git with the release and scm plugin without having to install a nativ git client. +This implementation uses username and password instead of a public/private keys to authenticate the requests to a remote repository like GitHub. + +Configuration +--- + +Usage with the `maven-release-plugin` + + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-release-plugin</artifactId> + <version>2.3</version> + <configuration> + <providerImplementations> + <git>jgit</git> + </providerImplementations> + </configuration> + <dependencies> + <dependency> + <groupId>org.apache.maven.scm</groupId> + <artifactId>maven-scm-provider-jgit</artifactId> + <version>1.8.1</version> + </dependency> + </dependencies> + </plugin> + +Usage with the `maven-scm-plugin` + + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.8.1</version> + <configuration> + <providerImplementations> + <git>jgit</git> + </providerImplementations> + </configuration> + <dependencies> + <dependency> + <groupId>org.apache.maven.scm</groupId> + <artifactId>maven-scm-provider-jgit</artifactId> + <version>${jgit.provider.version}</version> + </dependency> + </dependencies> + </plugin> + +Examples +____ +changelog + + mvn org.apache.maven.plugins:maven-scm-plugin:1.8.1:changelog + +release + + mvn release:prepare release:perform -Dresume=false -Dusername=XXX -Dpassword=XXX + + + + + +Features +--- + +this is a brief list of the supported maven-scm-provider-jgit's integration status with regard to some core maven plugins + + +maven-scm-plugin +--- + +| goal | implemented?| +| ------------- |:-------------:| +| scm:list | yes | +| scm:tag | yes | +| scm:bootstrap | no | +| scm:export | no | +| scm:update | no | +| scm:status | yes | +| scm:edit | no | +| scm:changelog | yes | +| scm:add | yes | +| scm:unedit | no | +| scm:validate | yes | +| scm:branch | yes | +| scm:checkin | yes | +| scm:checkout | yes | +| scm:diff | yes | + +maven-release-plugin +--- + +| goal | implemented?| +| ------------- |:-------------:| +| release:clean | yes | +| release:prepare | yes | +| release:rollback | no | +| release:perform | yes | +| release:stage | no | +| release:branch | yes | \ No newline at end of file
