diff --git a/pom.xml b/pom.xml index 5821702..8aafb9b 100644 --- a/pom.xml +++ b/pom.xml @@ -19,7 +19,7 @@ under the License. --> - + 4.0.0 @@ -38,12 +38,12 @@ Tidy Plugin for Maven. The Tidy plugin provides goals for tidying up your source code. - http://www.mojohaus.org/tidy-maven-plugin/ + https://www.mojohaus.org/tidy-maven-plugin/ 2011 The Apache Software License, Version 2.0 - http://www.apache.org/licenses/LICENSE-2.0.txt + https://www.apache.org/licenses/LICENSE-2.0.txt repo @@ -66,19 +66,9 @@ scm:git:https://github.com/mojohaus/tidy-maven-plugin.git scm:git:ssh://git@github.com/mojohaus/tidy-maven-plugin.git - https://github.com/mojohaus/tidy-maven-plugin + https://github.com/mojohaus/tidy-maven-plugin/tree/master HEAD - - GitHub - https://github.com/mojohaus/tidy-maven-plugin/issues - - - - github - scm:git:git@github.com:mojohaus/tidy-maven-plugin.git - - 3.2.5 @@ -96,10 +86,30 @@ + + + org.apache.maven + maven-plugin-api + ${mavenVersion} + provided + + + org.apache.maven + maven-core + ${mavenVersion} + provided + + + org.apache.maven.plugin-tools + maven-plugin-annotations + provided + + org.codehaus.plexus plexus-utils + com.fasterxml.woodstox woodstox-core @@ -116,25 +126,8 @@ stax2-api 3.1.4 - - org.apache.maven - maven-plugin-api - - ${mavenVersion} - provided - - - org.apache.maven - maven-compat - ${mavenVersion} - provided - - - org.apache.maven.plugin-tools - maven-plugin-annotations - 3.4 - provided - + + org.junit.jupiter junit-jupiter-engine @@ -149,62 +142,6 @@ - - - - maven-site-plugin - - ${project.distributionManagement.site.url} - - - - org.apache.maven.doxia - doxia-module-markdown - 1.11.1 - - - - - org.apache.maven.plugins - maven-plugin-plugin - - true - - - - mojo-descriptor - - descriptor - - - - - - - org.apache.maven.plugins - maven-scm-publish-plugin - - - ${project.build.directory}/site - - - - - - - - - org.apache.maven.plugins - maven-plugin-plugin - - - 256m - - - - - - run-its diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index 77d833f..346c92d 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -1,30 +1,36 @@ -[//]: # (Licensed to the Apache Software Foundation (ASF) under one) -[//]: # (or more contributor license agreements. See the NOTICE file) -[//]: # (distributed with this work for additional information) -[//]: # (regarding copyright ownership. The ASF licenses this file) -[//]: # (to you under the Apache License, Version 2.0 (the) -[//]: # ("License"); you may not use this file except in compliance) -[//]: # (with the License. You may obtain a copy of the License at) -[//]: # ( http://www.apache.org/licenses/LICENSE-2.0) -[//]: # (Unless required by applicable law or agreed to in writing,) -[//]: # (software distributed under the License is distributed on an) -[//]: # ("AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY) -[//]: # (KIND, either express or implied. See the License for the) -[//]: # (specific language governing permissions and limitations) -[//]: # (under the License.) -## Tidy Maven Plugin + + +Tidy Maven Plugin +================= The Tidy Plugin tidies up a project's `pom.xml` and optionally verifies that it is tidy. -### Goals Overview +Goals Overview +-------------- The Tidy Plugin has two goals. * [tidy:pom](./pom-mojo.html) tidies up the project's `pom.xml`. * [tidy:check](./check-mojo.html) checks that the project's `pom.xml` is tidy. -### Usage +Usage +----- General instructions on how to use the different goals of the Tidy Plugin can be found on the [usage page](./usage.html). diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm index 87a7c03..9c76175 100644 --- a/src/site/markdown/usage.md.vm +++ b/src/site/markdown/usage.md.vm @@ -1,22 +1,27 @@ -[//]: # (Licensed to the Apache Software Foundation (ASF) under one) -[//]: # (or more contributor license agreements. See the NOTICE file) -[//]: # (distributed with this work for additional information) -[//]: # (regarding copyright ownership. The ASF licenses this file) -[//]: # (to you under the Apache License, Version 2.0 (the) -[//]: # ("License"); you may not use this file except in compliance) -[//]: # (with the License. You may obtain a copy of the License at) -[//]: # ( http://www.apache.org/licenses/LICENSE-2.0) -[//]: # (Unless required by applicable law or agreed to in writing,) -[//]: # (software distributed under the License is distributed on an) -[//]: # ("AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY) -[//]: # (KIND, either express or implied. See the License for the) -[//]: # (specific language governing permissions and limitations) -[//]: # (under the License.) -## Usage + + +Usage +===== The following examples describe the basic usage of the Tidy Plugin. -### Format the POM +Format the POM +-------------- To format the `pom.xml` execute the `pom` goal manually. @@ -50,7 +55,8 @@ Note: The following sections potentially can affect the build process if the chi * `/project/dependencies` * `/project/build/plugins` -### Checking for Tidy POM as Part of the Build +Checking for Tidy POM as Part of the Build +------------------------------------------ If you want to fail the build for a POM that is not formatted according to the `pom` goal, you must add an execution of `tidy:check` to the `build` element. diff --git a/src/site/site.xml b/src/site/site.xml index 11c58e5..3fd52bb 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -1,12 +1,13 @@ - - - - - mojohaus/${project.artifactId} - - - + + + + + + + +