### Build SortPom Plugin (without signing)

Source: https://github.com/ekryd/sortpom/blob/master/misc/welcome.txt

Use this command to compile and install the SortPom plugin locally without signing the JAR file.

```bash
mvn clean install
```

--------------------------------

### Example POM Dependency Structure

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

Illustrates a Maven POM structure with dependency management defining scopes and dependencies without explicit scopes. This can lead to sorting issues if not handled carefully.

```xml
<dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
        <scope>test</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.hamcrest</groupId>
      <artifactId>hamcrest-all</artifactId>
      <version>1.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
    </dependency>
  </dependencies>
```

--------------------------------

### SortPlugins Configuration Example

Source: https://github.com/ekryd/sortpom/wiki/SortPlugins

Configure the sortPlugins parameter with a comma-separated list of elements to define the sorting order for plugins. Elements like groupId and artifactId can be used.

```properties
sortPlugins=groupId,artifactId
```

--------------------------------

### Properly Bound Comment in POM

Source: https://github.com/ekryd/sortpom/wiki/Comments

This example shows a comment correctly bound to the `<properties>` element. Comments should precede the element they are intended for.

```xml
  <!— This is a comment that is bound to the properties element —>
  <properties>
    <compileSource>1.6</compileSource>
    <my.property>Special value</my.property>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
```

--------------------------------

### Misplaced Comment in POM

Source: https://github.com/ekryd/sortpom/wiki/Comments

This example illustrates a comment placed after an XML element, which SortPom binds to the subsequent element (`<groupId>`) instead of the intended one (`<version>`). Avoid placing comments after XML elements.

```xml
  <plugin>
    <version>2.3</version>  <!— This comment is bound to the groupId element (not version) —>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jxr-plugin</artifactId>
  </plugin>
```

--------------------------------

### Release SortPom Plugin - Prepare

Source: https://github.com/ekryd/sortpom/blob/master/misc/welcome.txt

Commands to prepare for releasing a new version of the SortPom plugin.

```bash
mvn release:clean
mvn release:prepare
```

--------------------------------

### Test GPG Signing

Source: https://github.com/ekryd/sortpom/blob/master/misc/welcome.txt

This command tests the GPG signing process before deploying the plugin.

```bash
echo "test" | gpg --clearsign
```

--------------------------------

### Set Backup File Extension

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Configure the file extension for backup files created before sorting. Use the `-D` flag for command-line or XML tags for configuration.

```bash
-Dsort.backupFileExtension=".old"
```

```xml
<backupFileExtension>.old</backupFileExtension>
```

--------------------------------

### Release SortPom Plugin - Perform

Source: https://github.com/ekryd/sortpom/blob/master/misc/welcome.txt

Command to perform the release of the SortPom plugin after preparation.

```bash
mvn release:perform
```

--------------------------------

### Display Plugin and Dependency Updates

Source: https://github.com/ekryd/sortpom/blob/master/misc/welcome.txt

Use these commands to check for available updates for plugins and dependencies in the Maven project.

```bash
mvn versions:display-plugin-updates
mvn versions:display-dependency-updates
```

--------------------------------

### SortPom Build and Tooling Commands

Source: https://github.com/ekryd/sortpom/blob/master/AGENTS.md

These Maven commands are used for building, testing, and formatting the SortPom project. Always run `mvn fmt:format` before committing to ensure code adheres to the project's style.

```bash
mvn verify              # Full build: compile, test, integration tests
```

```bash
mvn test                # Unit tests only
```

```bash
mvn fmt:format          # Auto-format all Java source (Spotify fmt-maven-plugin)
```

```bash
mvn fmt:check           # Verify formatting without modifying files
```

--------------------------------

### Run SortPom Sort Goal with Custom Order

Source: https://github.com/ekryd/sortpom/blob/master/README.md

Execute the 'sort' goal of the SortPom plugin directly from the command line with a predefined custom sort order. This is useful for simple tests.

```bash
mvn com.github.ekryd.sortpom:sortpom-maven-plugin:4.0.0:sort -Dsort.predefinedSortOrder=custom_1
```

--------------------------------

### Control Expansion of Empty Elements

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Configure whether empty XML elements should be expanded (e.g., `<configuration></configuration>`) or collapsed (`<configuration />`). Use the `-D` flag for command-line or XML tags for configuration.

```bash
-Dsort.expandEmptyElements=false
```

```xml
<expandEmptyElements>false</expandEmptyElements>
```

--------------------------------

### Simple Maven Plugin Configuration

Source: https://github.com/ekryd/sortpom/wiki/Recommended-configuration

Add this to your pom.xml to sort your pom file automatically during compilation.

```xml
<build>
  <plugins>
    <plugin>
      <groupId>com.github.ekryd.sortpom</groupId>
      <artifactId>sortpom-maven-plugin</artifactId>
      <version>3.3.0</version>
      <executions>
        <execution>
          <goals>
            <goal>sort</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
```

--------------------------------

### Running SortPom with Custom Sort Order File

Source: https://github.com/ekryd/sortpom/wiki/SortPlugins

Execute the SortPom Maven plugin with a custom sort order file specified using the -Dsort.sortOrderFile parameter.

```bash
mvn sortpom:sort -Dsort.sortOrderFile=<your own file here>
```

--------------------------------

### Sort Plugins Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Use this parameter to define a comma-separated list of how plugins should be sorted. This enables custom sorting mechanisms for plugins within the pom.xml.

```bash
-Dsort.sortPlugins=groupId,artifactId
```

```xml
<sortPlugins>groupId,artifactId</sortPlugins>
```

--------------------------------

### Sort Order File Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Specify a custom sort order file to be read from the executing path, classpath, or as a URL. This allows for fine-grained control over the sorting logic.

```bash
-Dsort.sortOrderFile="src/main/resources/customSortOrder.xml"
```

```xml
<sortOrderFile>src/main/resources/customSortOrder.xml</sortOrderFile>
```

```xml
<sortOrderFile>https://raw.githubusercontent.com/Ekryd/sortpom/master/sorter/src/main/resources/custom_1.xml</sortOrderFile>
```

--------------------------------

### SortPom Maven Plugin Configuration for Build Servers

Source: https://github.com/ekryd/sortpom/wiki/SortPom-and-Build-Servers

This snippet shows how to configure the SortPom Maven plugin to use the 'verify' goal. It's recommended for build servers to prevent accidental modifications to the POM file. The configuration includes settings for encoding, sorting order, dependency sorting, and property sorting.

```xml
...
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    ...
  </properties>

...
      <plugin>
        <groupId>com.github.ekryd.sortpom</groupId>
        <artifactId>sortpom-maven-plugin</artifactId>
        <version>2.12.0</version>
        <configuration>
          <encoding>${project.build.sourceEncoding}</encoding>
          <keepBlankLines>true</keepBlankLines>
          <predefinedSortOrder>custom_1</predefinedSortOrder>
          <sortDependencies>scope</sortDependencies>
          <sortProperties>true</sortProperties>
          <verifyFail>stop</verifyFail>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>verify</goal>
            </goals>
            <phase>validate</phase>
          </execution>
        </executions>
      </plugin>
...
```

--------------------------------

### Run Single Integration Test

Source: https://github.com/ekryd/sortpom/blob/master/maven-plugin/src/it/README_IT_TESTS.md

Execute a single integration test by specifying the test name with the 'invoker.test' property. This command also skips other tests and Javadoc generation.

```bash
mvn verify -DskipTests=true -Dmaven.javadoc.skip=true -Dinvoker.test=mojo-description
```

--------------------------------

### Integration Tests with SortPomImpl

Source: https://github.com/ekryd/sortpom/blob/master/AGENTS.md

Perform full integration testing through SortPomImpl. This utility allows configuring dependency sorting and testing input/output files.

```java
SortPomImplUtil.create()
    .sortDependencies("scope,groupId,artifactId")
    .testFiles("src/test/resources/MyFeature_input.xml",
               "src/test/resources/MyFeature_expected.xml");
```

--------------------------------

### Configure verifyFailOn for Strict Verification

Source: https://github.com/ekryd/sortpom/wiki/VerifyFailOn

This snippet shows how to configure the sortpom-maven-plugin to use the 'strict' verifyFailOn setting. This enforces checks for sorting, indentation, and line separators, failing the build if any issues are found.

```xml
      <plugin>
        <groupId>com.github.ekryd.sortpom</groupId>
        <artifactId>sortpom-maven-plugin</artifactId>
        <version>2.13.1</version>
        <configuration>
          <encoding>${project.build.sourceEncoding}</encoding>
          <keepBlankLines>true</keepBlankLines>
          <predefinedSortOrder>custom_1</predefinedSortOrder>
          <ignoreLineSeparators>false</ignoreLineSeparators>
          <verifyFail>stop</verifyFail>
          <verifyFailOn>strict</verifyFailOn>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>verify</goal>
            </goals>
            <phase>validate</phase>
          </execution>
        </executions>
      </plugin>
```

--------------------------------

### Sort Dependencies by GroupId and ArtifactId

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

Configure the plugin to sort dependencies first by groupId and then by artifactId. The separator can be a semicolon, colon, or comma. Avoid spaces in the list.

```xml
sortDependencies=groupId,artifactId
```

--------------------------------

### Maven Settings for Plugin Group

Source: https://github.com/ekryd/sortpom/wiki/Recommended-configuration

Add this plugin group to your ~/.m2/settings.xml to simplify command-line execution of SortPom goals.

```xml
<settings>
	
	<pluginGroups>
  		<pluginGroup>com.github.ekryd.sortpom</pluginGroup>
	</pluginGroups>
	

```

--------------------------------

### XML Sorting and Round-trip Tests

Source: https://github.com/ekryd/sortpom/blob/master/AGENTS.md

Use this utility for testing XML sorting and round-trip functionality. It allows specifying a predefined sort order and testing input against expected output files.

```java
XmlProcessorTestUtil.create()
    .predefinedSortOrder("recommended_2008_06")
    .testInputAndExpected("src/test/resources/MyFeature_input.xml",
                          "src/test/resources/MyFeature_expected.xml");
```

--------------------------------

### Manage Git Tags for Rollback

Source: https://github.com/ekryd/sortpom/blob/master/rollback.txt

Commands to list, delete, and push tag deletions for Git.

```bash
git tag
```

```bash
git tag -d <tag>
```

```bash
git push origin :refs/tags/<tag>
```

--------------------------------

### Configure Sortpom for Other XML Files

Source: https://github.com/ekryd/sortpom/wiki/SortingOtherXml

Use these parameters within your Sortpom configuration to specify the XML file to be sorted and a schema file that defines the desired sort order.

```xml
<pomFile>myFile.xml</pomFile>
<sortOrderFile>sortSchemaOrder.xml</sortOrderFile>
```

--------------------------------

### Set File Encoding

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Specify the character encoding for processing pom files. Use the `-D` flag for command-line or XML tags for configuration.

```bash
-Dsort.encoding="ASCII"
```

```xml
<encoding>ASCII</encoding>
```

--------------------------------

### Sort pom.xml using Sortpom Maven Plugin

Source: https://github.com/ekryd/sortpom/wiki/Home

This command sorts the current pom.xml file using the Sortpom Maven Plugin. It also preserves blank lines and uses a custom predefined sort order.

```bash
mvn com.github.ekryd.sortpom:sortpom-maven-plugin:sort -Dsort.keepBlankLines -Dsort.predefinedSortOrder=custom_1
```

--------------------------------

### Placing a Critical Dependency at the Top

Source: https://github.com/ekryd/sortpom/wiki/IgnoringSections

Wrap a critical dependency within `<?SORTPOM IGNORE?>` and `<?SORTPOM RESUME?>` directives to ensure it appears at the top of the dependencies list when `sortDependencies` is configured. This is a workaround for class loading issues and may change in future versions.

```xml
<dependencies>
    <dependency>
      <?SORTPOM IGNORE?>
      <groupId>org.jmockit</groupId>
      <artifactId>jmockit</artifactId>
      <scope>test</scope>
      <?SORTPOM RESUME?>
    </dependency>
    <dependency>
      <groupId>org.hamcrest</groupId>
      <artifactId>hamcrest</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter-engine</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-junit-jupiter</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>
```

--------------------------------

### Ignoring a Dependency Version

Source: https://github.com/ekryd/sortpom/wiki/IgnoringSections

Use `<?SORTPOM IGNORE?>` and `<?SORTPOM RESUME?>` to prevent a specific dependency's version from being sorted. This ensures the comment stays on the same line as the version.

```xml
<dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <?SORTPOM IGNORE?>
            <version>2.0</version><!--$NO-MVN-MAN-VER$ -->
            <?SORTPOM RESUME?>
        </dependency>
```

--------------------------------

### Advanced Maven Plugin Configuration

Source: https://github.com/ekryd/sortpom/wiki/Recommended-configuration

Configure SortPom with specific parameters for custom sorting, no backup files, and line endings. Ensure changes are committed before use, as this does not create backups.

```xml
<build>
    <plugins>
      <plugin>
        <groupId>com.github.ekryd.sortpom</groupId>
        <artifactId>sortpom-maven-plugin</artifactId>
        <version>3.3.0</version>
        <configuration>
          <createBackupFile>false</createBackupFile>
          <predefinedSortOrder>custom_1</predefinedSortOrder>
          <lineSeparator>\n</lineSeparator>
          <sortProperties>true</sortProperties>
          <sortDependencies>scope,groupId,artifactId</sortDependencies>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>sort</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

      <!-- ... (Other plugins) -->
    </plugins>
   
    <!-- ... (Other build configurations) -->
</build>
```

--------------------------------

### Disable Backup File Creation

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Control whether a backup copy of the pom file is created before sorting. Use the `-D` flag for command-line or XML tags for configuration.

```bash
-Dsort.createBackupFile=false
```

```xml
<createBackupFile>false</createBackupFile>
```

--------------------------------

### Dependency Sorting with Scope

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

When 'scope' is included in the sort order, it follows a specific hierarchy: IMPORT, COMPILE (or empty), PROVIDED, SYSTEM, RUNTIME, and TEST. Since version 3.0.0, IMPORT is sorted first.

```xml
sortDependencies=scope
```

--------------------------------

### Omit Sorting Dependencies

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

Use the value 'none' to disable sorting for dependencies. This is useful when combined with other sorting rules for dependency management.

```xml
sortDependencies=none
```

--------------------------------

### Sort Modules Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Configure this parameter to sort the Maven pom sub modules alphabetically. This setting is applicable through both command-line arguments and pom.xml configuration.

```bash
-Dsort.sortModules=true
```

```xml
<sortModules>true</sortModules>
```

--------------------------------

### Space Before Close Empty Element Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Control whether non-expanded empty XML elements should contain a space before the closing tag. This affects the formatting of empty elements like `<configuration />` vs `<configuration/>`.

```bash
-Dsort.spaceBeforeCloseEmptyElement=true
```

```xml
<spaceBeforeCloseEmptyElement>true</spaceBeforeCloseEmptyElement>
```

--------------------------------

### Custom Sort Order File for Report Plugins

Source: https://github.com/ekryd/sortpom/wiki/SortPlugins

Define a custom sort order file to manage the sorting of report plugins, as they are not part of the standard Maven POM specification. This snippet shows the structure required within the custom file.

```xml
<configuration>
          <reportPlugins>
            <plugin>
              <groupId/>
              <artifactId/>
              <version/>
              <configuration>
              </configuration>
              <reports>
                <report/>
              </reports>
            </plugin>
          </reportPlugins>            
        </configuration>
```

--------------------------------

### Rollback Maven Release

Source: https://github.com/ekryd/sortpom/blob/master/rollback.txt

Use these commands to rollback a Maven release. This cleans up release artifacts and resets the Git repository.

```bash
mvn release:rollback
mvn release:clean
```

```bash
git reset HEAD^ --hard
git push origin -f
```

--------------------------------

### Sort Executions Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Use this parameter to sort the Maven pom execution sections by phase and then alphabetically. It can be set via the command line or within the pom.xml.

```bash
-Dsort.sortExecutions=true
```

```xml
<sortExecutions>true</sortExecutions>
```

--------------------------------

### Omit Sorting Dependency Management

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

Set the dependency management sorting to 'none' to prevent it from being sorted. This is recommended when dependency management might interfere with normal dependency sorting.

```xml
<sortDependencyManagement>none</sortDependencyManagement>
```

--------------------------------

### Sort Properties Parameter

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Set this parameter to true to sort the Maven pom properties alphabetically. This affects both project properties and properties within profiles.

```bash
-Dsort.sortProperties=true
```

```xml
<sortProperties>true</sortProperties>
```

--------------------------------

### Configure SortPom Plugin in Maven Build

Source: https://github.com/ekryd/sortpom/blob/master/README.md

Integrate the SortPom plugin into your Maven build to automatically sort pom.xml during compilation. Ensure you replace '4.0.0' with the latest version.

```xml
<build>
  <plugins>
    <plugin>
      <groupId>com.github.ekryd.sortpom</groupId>
      <artifactId>sortpom-maven-plugin</artifactId>
      <version>4.0.0</version>
      <executions>
        <execution>
          <goals>
            <goal>sort</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>
```

--------------------------------

### Version 2.0.0 and Earlier Boolean Sort Argument

Source: https://github.com/ekryd/sortpom/wiki/SortDependencies

In versions 2.0.0 and earlier, a boolean argument was used for sorting: 'true' meant 'groupId,artifactId', and 'false' meant an empty list. This is no longer supported since version 3.0.0.

```xml
true means 'groupId,artifactId'
```

```xml
false means empty list.
```

--------------------------------

### Ensure Newline at End of File

Source: https://github.com/ekryd/sortpom/wiki/Parameters

Determine if the sorted pom file should end with a newline character. Use the `-D` flag for command-line or XML tags for configuration.

```bash
-Dsort.endWithNewline=false
```

```xml
<endWithNewline>false</endWithNewline>
```

--------------------------------

### SortPom Violation File Structure

Source: https://github.com/ekryd/sortpom/wiki/ViolationFile

This XML structure represents a violation detected by SortPom. It indicates the file path and the specific XML element ordering issue.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<sortpom>
  <file filename="/Users/myUser/Workspace/SortPom/maven-plugin/target/it/violation-file/pom.xml">
    <violation>The xml element &lt;modelVersion&gt; should be placed before &lt;name&gt;</violation>
  </file>
</sortpom>
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.