Publishing

Checklist for publishing a new version of the API

Note: this page is intended to be used by maintainers.

0. Make sure to be working on the dev branch!
1. Update every <version> tag in pom.xml files using the command

mvn org.codehaus.mojo:versions-maven-plugin:2.16.1:set -DgenerateBackupPoms=false -DprocessAllModules=true -DnewVersion=X.X.X

4. Update Versions#API_VERSION in NMS/Common module
5. Update the version and the 3.0.0 javadoc link in the README
6. Open terminal in main folder and try to compile with mvn clean package -U. At the end of compilation, make sure that every module's version has been updated to the new one.
7. Push to GitHub (commit named Update version to X.X.X)
8. Wait for Jenkins to finish building
9. Open pull request from dev to main (with Update to X.X.X as title and the changelog as comment)
   Template:

* Updated version to X.X.X
* Updated to Minecraft 1.X.X
* Updated CommandAPI to X.X.X
* Changelog
* Changelog by @user

10. Merge pull request (remember to keep the changelog as comment)
11. Wait for Jenkins to finish building
12. On GitHub desktop:
    1. Checkout the main branch
    2. Pull
    3. Open the History tab
    4. Right-click the last commit and press Create Tag...
    5. Call the tag as the version to publish (i.e. X.X.X)
       Create the 3.0.0 tag AFTER the 2.X.X one!
    6. Push
    7. Checkout the dev branch
    8. Merge the main branch into dev USING THE GUI
    9. Push
13. Checkout the main branch
14. Open terminal in main folder and deploy to maven repo using: mvn clean deploy -U
15. Checkout the dev branch. This avoids making further changes on the main branch by mistake!

Javadoc

1. Open site folder and go to SITE-MAIN-FOLDER/javadocs/UltimateAdvancementAPI/
2. Create a folder called as the version to publish (i.e. X.X.X)
3. Do cp -r ./build-server/main/* X.X.X/

Wiki

1. Open https://github.com/frengor/UltimateAdvancementAPI/wiki
2. Update the old version in every maven snippet
   Known pages where the update is to be done:
   • Start Guide
   • Shadeable Version
3. If configuration changed, then the Configuration page should be adjusted

SpigotMC

1. Update the version in the maven snippet in the main page
2. Update the remaining parts of the main page (remember the title and 3.0.0-beta javadoc links)
3. Update the resource
   Remember to use the file downloaded from Jenkins
   BB-Code changelog template (use [icode] for inline code):

You can support the development of UltimateAdvancementAPI by contributions or by [URL='https://github.com/sponsors/frengor']sponsoring the project on Github[/URL].

[COLOR=#808080][B]Release X.X.X:[/B][/COLOR]
[LIST]
[*]Added support for Minecraft 1.X.X
[*]Updated CommandAPI to X.X.X
[*]Changelog here
[*]Changelog here (by @User)
[/LIST]
Internal changes:
[LIST]
[*]Changelog here
[/LIST]

Generator message

[COLOR=rgb(128, 128, 128)][B]UltimateAdvancementGenerator:[/B][/COLOR]
[LIST]
[*]Changelog here
[*]The tool is still in [COLOR=rgb(255, 0, 0)]BETA[/COLOR], please report bugs and wanted features on [URL='https://github.com/frengor/UltimateAdvancementAPI/issues']GitHub[/URL]
[/LIST]

Modrinth

1. Update the version in the maven snippet in the main page
2. Update the remaining parts of the main page (remember the 3.0.0-beta javadoc links)
3. Update the resource
   Remember to use the file downloaded from Jenkins
   Select the loaders: Bukkit, Spigot, Paper
   Select all the supported versions
   Upload the mojang-mapped artifact as additional file
   Markdown template:

You can support the development of UltimateAdvancementAPI by contributions or by [sponsoring the project on Github](https://github.com/sponsors/frengor).

* Added support for Minecraft 1.X.X
* Updated CommandAPI to X.X.X
* Changelog here
* Changelog here (by [User](https://github.com/user))
#### Internal changes:
* Changelog here

Generator message

### UltimateAdvancementGenerator
* Changelog here
* The tool is still in **BETA**, please report bugs and wanted features on [GitHub](https://github.com/frengor/UltimateAdvancementAPI/issues)

Hangar

1. Update the version in the maven snippet in the main page
2. Update the remaining parts of the main page (remember the 3.0.0-beta javadoc links)
3. Update the resource
   Remember to use the file downloaded from Jenkins
   Select the loader: Paper
   Select all the supported versions
   Markdown template (or just copy it from Modrinth):

You can support the development of UltimateAdvancementAPI by contributions or by [sponsoring the project on Github](https://github.com/sponsors/frengor).
<br><br>

* Added support for Minecraft 1.X.X
* Updated CommandAPI to X.X.X
* Changelog here
* Changelog here (by [User](https://github.com/user))
#### Internal changes:
* Changelog here

Generator message

### UltimateAdvancementGenerator
* Changelog here
* The tool is still in **BETA**, please report bugs and wanted features on [GitHub](https://github.com/frengor/UltimateAdvancementAPI/issues)

Discord

1. Post a message in the announcements channel
   Message template:

**X.X.X and 3.0.0-beta-X Update**
Download it from:
*Modrinth:* [X.X.X](https://modrinth.com/plugin/ultimateadvancementapi/version/X.X.X) / [3.0.0-beta-X](https://modrinth.com/plugin/ultimateadvancementapi/version/3.0.0-beta-X)
*Hangar:* [X.X.X](https://hangar.papermc.io/DevHeim/UltimateAdvancementAPI/versions/X.X.X) / [3.0.0-beta-X](https://hangar.papermc.io/DevHeim/UltimateAdvancementAPI/versions/3.0.0-beta-X)
*Spigot:* <https://www.spigotmc.org/resources/95585/>

You can support the development of UltimateAdvancementAPI by contributions or by [sponsoring the project on Github](https://github.com/sponsors/frengor).

> **Changelog:**
> * Added support for Minecraft 1.X.X
> * Updated CommandAPI to X.X.X
> * Changelog here
> * Changelog here (by @User)
> * Sublist title:
>   * Changelog here
>   * Changelog here (by @User)
> 
> Internal changes:
> * Changelog here
||@UltimateAdvancementAPI||

Old message

**X.X.X Update**
Download it from:
*Modrinth:* <https://modrinth.com/plugin/ultimateadvancementapi/version/X.X.X>
*Spigot:* <https://www.spigotmc.org/resources/95585/>
*Hangar:* <https://hangar.papermc.io/DevHeim/UltimateAdvancementAPI/versions/X.X.X>

You can support the development of UltimateAdvancementAPI by contributions or by [sponsoring the project on Github](https://github.com/sponsors/frengor).

> **Changelog:**
> * Added support for Minecraft 1.X.X
> * Updated CommandAPI to X.X.X
> * Changelog here
> * Changelog here (by @User)
> * Sublist title:
>   * Changelog here
>   * Changelog here (by @User)
> 
> Internal changes:
> * Changelog here
||@UltimateAdvancementAPI||