Useful for quicker and more efficient plugin development.
- Automatic builds, tests, and releases
- Discord notifications for builds, tests, and releases (optional) - More Info Here: Discord Message Notify
- Probot: Stale
- Sadly Deprecated, but still accessible via Probot: Stale
- Dependabot
- Update GitHub actions workflow
- Update Gradle dependencies
- PaperLib for Paper / Spigot api interfacing
- Paper for main plugin api
- SpotBugs for static analysis
- CheckStyle to enforce code style
- updated project name in
settings.gradle.kts - updated project group in
build.gradle.kts(not required) - updated
plugin.ymlwith correct information - updated
README.mdwith correct information
Stable versions of this repo are tagged vX.Y.Z and have an associated release.
Testing versions of this repo are tagged vX.Y.Z-RC-N and have an associated pre-release.
Development versions of this repo are pushed to the main branch and are not tagged.
| Event | Plugin Version Format | CI Action | GitHub Release Draft? |
|---|---|---|---|
| PR | yyMMdd-HHmm-SNAPSHOT | Build and test | No |
| Cron | yyMMdd-HHmm-SNAPSHOT | Build, test, and notify | No |
Push to main |
0.0.0-SNAPSHOT | Build, test, release, and notify | No |
Tag vX.Y.Z-RC-N |
X.Y.Z-SNAPSHOT | Build, test, release, and notify | Pre-release |
Tag vX.Y.Z |
X.Y.Z | Build, test, release, and notify | Release |
In order to use Discord notifications, you will need to create two GitHub secrets. DISCORD_WEBHOOK_ID
should be set to the id of your Discord webhook. DISCORD_WEBHOOK_TOKEN will be the token for the webhook.
You can find these values by copying the Discord Webhook URL:
https://discord.com/api/webhooks/<DISCORD_WEBHOOK_ID>/<DISCORD_WEBHOOK_TOKEN>
For more information, see Discord Message Notify.
Run the following command to build the project locally:
./gradlew buildThis will check with CodeStyle, SpotBugs, and build the project.
compiled JARs can be found in build/libs/.
Something to finish the README.md
