Permalink
Browse files

work before first release, adding license and readme etc

  • Loading branch information...
1 parent e5eb934 commit 3b14e7685e0973cd8fd7b89e7ee1095537c35103 @ktoso committed Feb 13, 2011
View
165 LICENSE
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
View
@@ -0,0 +1,90 @@
+Maven plugin: git-commit-id-plugin
+==================================
+git-commit-id-plugin is a plugin quite similar to https://fisheye.codehaus.org/browse/mojo/tags/buildnumber-maven-plugin-1.0-beta-4 fo example
+but as buildnumber only supports svn (which is very sad) and cvs (which is even more sad, and makes bunnies cry) I had to quickly develop
+an git version of such a plugin. For those who don't know the previous plugins, let me explain what this plugin does:
+
+If you develop your maven project inside an git repository (which you hopefully already are docing) you may want to know exactly
+what changeset is currently deployed online. Why is this useful? Well, the tester won't come to you screaming "heeey that bug ain't fixed"
+of course you'd reply "but I fixed it this morning!" and after some searching you notice "oh... it'll be online after the next deployment, sorry tester... :-(".
+This scenario keeps repeating sometimes, thus you can state which commit fixes/closes the bug, note this in JIRA etc and then the tester will know if it's already online (by the commit date for example).
+
+Usage
+=====
+It's really simple to setup this plugin, here's a sample pom that you may base your pom on:
+
+ <?xml version="1.0" encoding="UTF-8"?>
+ <project xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>pl.project13.maven</groupId>
+ <artifactId>my-git-plugin-sample-app</artifactId>
+ <packaging>war</packaging>
+ <version>0.1</version>
+ <name>my-git-plugin-sample-app</name>
+ <url>http://www.blog.project13.pl</url>
+
+ <parent/>
+
+ <dependencies />
+
+ <build>
+ <!-- GIT COMMIT ID PLUGIN CONFIGURATION -->
+ <resources>
+ <resource>
+ <directory>src/main/resources</directory>
+ <filtering>true</filtering>
+ <includes>
+ <include>**/*.properties</include>
+ <include>**/*.xml</include>
+ </includes>
+ </resource>
+ </resources>
+
+ <plugins>
+ <plugin>
+ <groupId>pl.project13.maven</groupId>
+ <artifactId>git-commit-id-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>revision</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <prefix>git</prefix> <!-- that's the default value -->
+ <dateFormat>dd.MM.yyyy '@' HH:mm:ss z</dateFormat> <!-- that's the default value -->
+ <verbose>true</verbose> <!-- false is default for this -->
+ <dotGitDirectory>${project.basedir}/../.git</dotGitDirectory> <!-- required, you have to specify this path -->
+ </configuration>
+ </plugin>
+ <!-- END OF GIT COMMIT ID PLUGIN CONFIGURATION -->
+
+ <plugin>
+ <groupId>org.mortbay.jetty</groupId>
+ <artifactId>maven-jetty-plugin</artifactId>
+ <version>6.1.10</version>
+ <configuration>
+ <contextPath>/management-ws</contextPath>
+ <stopKey>stop</stopKey>
+ <stopPort/>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <version>2.1.1</version>
+ <configuration>
+ <warName>management-ws</warName>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </project>
+
+Based on the above part of a working POM you should be able to figure out the rest, I mean you are a maven user after all... ;-)
+Note that the resources filtering is important for this plugin to work, don't omit it!
@@ -37,6 +37,7 @@
* Goal which touches a timestamp file.
*
* @author <a href="mailto:konrad.malawski@project13.pl">Konrad 'ktoso' Malawski</a>
+ * @since 1.0
*
* @goal revision
* @phase initialize
@@ -75,8 +76,9 @@
* The root directory of the repository we want to check
*
* @parameter
+ * @required
*/
- private File basedir;
+ private File dotGitDirectory;
/**
* The prefix to expose the properties on, for example 'git' would allow you to access '${git.branch}'
@@ -98,7 +100,7 @@
public final String logPrefix = "[GitCommitIdMojo] ";
public void execute() throws MojoExecutionException {
- getLog().info(logPrefix + "Running on '" + basedir.getAbsolutePath() + "' repository...");
+ getLog().info(logPrefix + "Running on '" + dotGitDirectory.getAbsolutePath() + "' repository...");
try {
initProperties();
@@ -198,13 +200,13 @@ private Repository getGitRepository() throws MojoExecutionException {
Repository repository = null;
FileRepositoryBuilder repositoryBuilder = new FileRepositoryBuilder();
- if (basedir == null) {
- basedir = project.getBasedir();
+ if (dotGitDirectory == null) {
+ dotGitDirectory = project.getBasedir();
}
try {
repository = repositoryBuilder
- .setGitDir(basedir)
+ .setGitDir(dotGitDirectory)
.readEnvironment() // scan environment GIT_* variables
// user.email etc. can be overridden by the GIT_AUTHOR_EMAIL, GIT_COMMITTER_EMAIL, and EMAIL environment variables
.findGitDir() // scan up the file system tree
@@ -214,7 +216,7 @@ private Repository getGitRepository() throws MojoExecutionException {
}
if (repository == null) {
- throw new MojoExecutionException("Could not create git repository. Are you sure '" + basedir + "' is the valid Git root for your project?");
+ throw new MojoExecutionException("Could not create git repository. Are you sure '" + dotGitDirectory + "' is the valid Git root for your project?");
}
return repository;
@@ -245,8 +247,8 @@ public void setVerbose(boolean verbose) {
this.verbose = verbose;
}
- public void setBasedir(File basedir) {
- this.basedir = basedir;
+ public void setDotGitDirectory(File dotGitDirectory) {
+ this.dotGitDirectory = dotGitDirectory;
}
public void setPrefix(String prefix) {
@@ -7,7 +7,8 @@
* with properties about the repository state at build time.
* This information is supplied by my plugin - <b>pl.project13.maven.git-commit-id-plugin</b>
*
- * @author Konrad Malawski
+ * @author <a href="mailto:konrad.malawski@project13.pl">Konrad 'ktoso' Malawski</a>
+ * @since 1.0
*/
//@JsonWriteNullProperties(true)
public class GitRepositoryState {
@@ -7,7 +7,7 @@
/**
* Date: 2/13/11
*
-* @author Konrad Malawski
+* @author <a href="mailto:konrad.malawski@project13.pl">Konrad 'ktoso' Malawski</a>
*/
class ContainsKeyCondition extends Condition<Map<?, ?>> {
@@ -1,3 +1,32 @@
+/*-
+ * Copyright (c) 2011, Oleg Estekhin
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the distribution.
+ * * Neither the names of the copyright holders nor the names of their
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
package pl.project13.maven.git;
import org.codehaus.plexus.PlexusTestCase;
@@ -10,15 +39,15 @@
/**
* Date: 2/13/11
*
- * @author Konrad Malawski
+ * @author <a href="mailto:konrad.malawski@project13.pl">Konrad 'ktoso' Malawski</a>
*/
public class GitCommitIdMojoTest extends PlexusTestCase {
GitCommitIdMojo mojo;
public void setUp() throws Exception {
mojo = new GitCommitIdMojo();
- mojo.setBasedir(new File("/home/ktoso/coding/maven-plugins/git-commit-id-plugin/.git/"));
+ mojo.setDotGitDirectory(new File("/home/ktoso/coding/maven-plugins/git-commit-id-plugin/.git/"));
mojo.setPrefix("git");
mojo.setDateFormat("dd.MM.yyyy '@' HH:mm:ss z");
mojo.setVerbose(true);

0 comments on commit 3b14e76

Please sign in to comment.