Skip to content

Commit

Permalink
Clean up poms for first release to maven central (#146)
Browse files Browse the repository at this point in the history
Also tidied up Javadoc in a few places, since we don't run those in CI
on a regular basis.
  • Loading branch information
niloc132 authored Mar 11, 2022
1 parent 20908fc commit d6a5723
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

/**
* Our own log api, which can forward to the calling tool's log.
*
* @todo support isDebug() etc, to avoid extra logging?
* @todo support trace logging, for some middle ground before debug?
*/
// TODO support isDebug(), etc, to avoid extra logging?
// TODO support trace logging, for some middle ground before debug?
public interface BuildLog {

void debug(String msg);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@ protected List<Project> scope(Collection<? extends Dependency> dependencies, Dep
}

/**
* @todo consider removing this, just assume that the name in the registry is enough to know what it is for?
* @return the output type that this task factory can emit
*/
// TODO Consider removing this, just assume that the name in the registry is enough to know what it is for?
public abstract String getOutputType();

/**
* The name to look for in configuration to specify an implementation
* @return The name to look for in configuration to specify an implementation
*/
public abstract String getTaskName();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,10 @@ public class BuildMojo extends AbstractBuildMojo {
protected String languageOut;

/**
* Closure flag: "Override the value of a variable annotated @define. The format is <name>[=<val>], where <name> is
* the name of a @define variable and <val> is a boolean, number, or a single-quoted string that contains no single
* quotes. If [=<val>] is omitted, the variable is marked true"
* Closure flag: "Override the value of a variable annotated {@code @define}. The format is
* {@code &lt;name&gt;[=&lt;val&gt;]}, where {@code &lt;name&gt;} is the name of a {@code @define}
* variable and {@code &lt;val&gt;} is a boolean, number, or a single-quoted string that contains
* no single quotes. If {@code [=&lt;val&gt;]} is omitted, the variable is marked true"
* <p></p>
* In this plugin the format is to provided tags for each define key, where the text contents will represent the
* value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,10 @@ public class TestMojo extends AbstractBuildMojo {
protected String languageOut;

/**
* Closure flag: "Override the value of a variable annotated @define. The format is <name>[=<val>], where <name> is
* the name of a @define variable and <val> is a boolean, number, or a single-quoted string that contains no single
* quotes. If [=<val>] is omitted, the variable is marked true"
* Closure flag: "Override the value of a variable annotated {@code @define}. The format is
* {@code &lt;name&gt;[=&lt;val&gt;]}, where {@code &lt;name&gt;} is the name of a {@code @define}
* variable and {@code &lt;val&gt;} is a boolean, number, or a single-quoted string that contains
* no single quotes. If {@code [=&lt;val&gt;]} is omitted, the variable is marked true"
* <p></p>
* In this plugin the format is to provided tags for each define key, where the text contents will represent the
* value.
Expand Down
66 changes: 62 additions & 4 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,65 @@
<packaging>pom</packaging>

<name>J2CL Build Tools</name>
<description>Collection of tools to make it easier to create J2CL build systems</description>
<description>
Collection of tools to make it easier to create J2CL build systems.
The first purpose of this set of tooling is to produce a maven plugin
capable of efficiently building J2CL projects, but the tools are
intended to be reused outside of maven.
</description>
<url>https://vertispan.github.io/j2clmavenplugin/</url>
<inceptionYear>2018</inceptionYear>

<licenses>
<license>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>

<developers>
<developer>
<name>Gabriele Cardosi</name>
</developer>
<developer>
<name>Colin Alworth</name>
<email>[email protected]</email>
<organization>Vertispan LLC</organization>
<organizationUrl>https://www.vertispan.com/</organizationUrl>
</developer>
<developer>
<name>Justin Hickman</name>
<email>[email protected]</email>
<organization>Vertispan LLC</organization>
<organizationUrl>https://www.vertispan.com/</organizationUrl>
</developer>
<developer>
<name>Frank Hossfeld</name>
<email>[email protected]</email>
<organization>Nalu Solutions GmbH</organization>
</developer>
<developer>
<name>Dmitrii Tikhomirov</name>
<email>[email protected]</email>
<organization>Red Hat, Inc.</organization>
</developer>
<developer>
<name>Miroslav Pokorny</name>
<email>[email protected]</email>
</developer>
</developers>

<issueManagement>
<url>https://github.com/vertispan/j2clmavenplugin/issues</url>
<system>GitHub Issues</system>
</issueManagement>

<scm>
<connection>scm:git:https://github.com/vertispan/j2clmavenplugin.git</connection>
<developerConnection>scm:git:[email protected]:vertispan/j2clmavenplugin.git</developerConnection>
<url>https://github.com/vertispan/j2clmavenplugin</url>
</scm>

<modules>
<module>build-caching</module>
Expand Down Expand Up @@ -298,9 +356,9 @@

<distributionManagement>
<repository>
<id>vertispan-releases</id>
<name>Vertispan hosted artifacts-releases</name>
<url>https://repo.vertispan.com/j2cl</url>
<id>ossrh</id>
<name>Sonatype staging repository for Maven Central</name>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
<snapshotRepository>
<id>vertispan-snapshots</id>
Expand Down

0 comments on commit d6a5723

Please sign in to comment.