dotnet-maven-plugin – Plugin Documentation

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
dotnet:build	This goal calls `dotnet build` on the current project, be that a `.sln` or `.csproj` file. It will always add the command line option `-p:Version=<projectVersion>` with `projectVersion` being the goals parameter of the same name. This way the version of the build artifacts are managed in the pom.
dotnet:clean	This goal simply calls `dotnet clean`.
dotnet:help	Display help information on dotnet-maven-plugin. Call `mvn dotnet:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
dotnet:initialize	This goal registers nuget source repositories. A special one that helps mimic mavens local repository and additionally all repositories that are configured.
dotnet:install	This goal assumes the builds delivery artifacts to be located in the directory denoted by the goals `targetDirectory` parameter. It will simply copy all *.nupkg files located there to directory configured to be the local nuget directory.
dotnet:pack	This goal calls `dotnet pack` creating nuget packages (`*.nupgk`). The goal will call dotnet with `--no-build` as the project was already built in the `compile` phase by the `{@code build` goal}.
dotnet:push	This goal calls `nuget push` on every nupgk file located in the configured `targetDirectory`.
dotnet:test	This goal calls `dotnet test` to execute test. It will add the command line parameter `--no-build`, since the `compile` phase will already be called before the `test` phase. It will always configure the `trx` logger and transform the results to a valid `junit` description - enabling ci servers to collect the test results in the default format for maven builds. The goal will honour the reactors failure behaviour.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.9.0
JDK	17

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
from 0.0.6 to 0.0.8	-	17

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>de.eitco.cicd</groupId>
          <artifactId>dotnet-maven-plugin</artifactId>
          <version>0.0.8</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>de.eitco.cicd</groupId>
        <artifactId>dotnet-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"