A maven plugin for creating Wago.io mods/addons releases

Setup pom.xml in project

<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>com.ragedunicorn.tools.maven</groupId>
        <artifactId>wago-release-maven-plugin</artifactId>
        <version>[version]</version>
        <executions>
          <execution>
            <id>default-cli</id>
            <configuration>
              <projectId>[projectId]</projectId>
              <label>example-upload</label>
              <changelog>release description overwritten by release notes</changelog>
              <changelogFile>src/main/resources/release-notes-example.md</changelogFile>
                <supportedRetailPatch>[game-version]</supportedRetailPatch>
                <supportedWotlkcPatch>[game-version]</supportedWotlkcPatch>
                <supportedBccPatch>[game-version]</supportedBccPatch>
                <supportedClassicPatch>[game-version]</supportedClassicPatch>
              <stability>stable</stability>
              <file>[path-to-packaged-addon]</file>
              <server>[.m2/settings.xml server name]</server>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  [...]
</project>

mvn wago-release:wago-release

Before the plugin can be used an API token has to be generated.

See Wago.io documentation

Once the Api token is generated it can be stored inside the maven .m2/settings.xml.

<server>
 <id>wago-token</id>
 <passphrase>token</passphrase>
</server>

Make sure to use passphrase instead of usernameand password otherwise the plugin will not be able to recognize the token.

It is also possible to set the token with the parameter authToken directly inside the plugin configuration. This is however not recommended because those pom files are usually getting commited into source control and potentially leaking the token. However, using maven commandline this can be useful being able to overwrite this parameter with the -D option.

<configuration>
  ...
  <authToken>${wago.auth-token}</authToken>
</configuration>

Then invoking via the command line

mvn wago-release:wago-release -D wago.auth-token=[token]

Basic tests can be executed with:

mvn test

Tests are kept basic because for most of the functionality the Wago.io backend is required.

The project contains IntelliJ run configurations that can be used for most tasks. All configurations can be found in the .run folder.

wago-release-maven-plugin

clean install

This project has GitHub action profiles for different Devops related work such as deployments to different places. See .github folder for details. The project is deployed to three different places. Each deployment has its own Maven profile for configuration.

.github/workflows/github_release.yaml - Creates a tag and release on GitHub

.github/workflows/github_package_release.yaml - Releases a package on GitHub

.github/workflows/ossrh_package_release.yaml - Releases a package on OSSRH (Sonatype)

All steps are required to make a full release of the plugin but can be done independently of each other. The workflows have to be manually invoked on GitHub.

The example can be used for testing of the plugin during development. It requires some manual setup on GitHub before it can be run.

• Setup wago token

wago-release-maven-plugin/example

clean install

Executing the plugin from a different folder won't work without also fixing the path to the release notes and any additional assets configured.

Note: The example module is deliberately not included as default module otherwise it would execute each time the project is built. Instead, the module can be considered separate and independent. It is an example of how to use the plugin, and it is helpful in testing the plugin during development.

wago-release-maven-plugin/plugin

mvn checkstyle:checkstyle

wago-release-maven-plugin/plugin

mvn pmd:pmd

Copyright (c) 2023 Michael Wiesendanger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.