Switch to semantic versioning with weekly dev and monthly release builds

.github/dependabot.yml

@@ -26,6 +26,9 @@ updates:
     schedule:
       interval: "weekly"
     target-branch: "dev"
+    labels:
+      - "dependencies"
+      - "build:patch"
     registries:
       - magemonkey-releases
       - magemonkey-snapshots

.github/workflows/devbuild.yml

@@ -1,16 +1,28 @@
 name: Dev Build
 
+# Weekly X.Y.Z-SNAPSHOT build of dev, where X.Y.Z is the next release (see release.yml).
+# Skipped when nothing was committed that week; run it by hand to publish one sooner.
 on:
-  push:
-    branches: [ dev ]
-    paths: [ '**/src/**' ]
+  schedule:
+    - cron: '17 12 * * 1'   # Mondays 12:17 UTC
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'Only compute and print the version'
+        type: boolean
+        default: false
+
+permissions:
+  contents: write
+  pull-requests: read
 
 jobs:
   deploy:
-    uses: magemonkeystudio/.github/.github/workflows/reusable-build.yml@main
+    uses: magemonkeystudio/.github/.github/workflows/reusable-semver-build.yml@main
     secrets: inherit
     with:
-      is_dev: true
+      mode: dev
+      dry_run: ${{ inputs.dry_run || false }}
       maven_args: '-DskipNms'
       java_version: '25'
       artifact_filter: 'codex'

.github/workflows/release.yml

@@ -1,16 +1,30 @@
 name: Release Build
 
+# Monthly X.Y.Z release of dev. The bump is the highest build:major/minor/patch label among
+# the PRs merged since the last release. Tags the release, publishes it, creates a
+# GitHub release and fast-forwards main to it. Skipped when nothing changed.
 on:
-  push:
-    branches: [ main ]
-    paths: [ '**/src/**' ]
+  schedule:
+    - cron: '23 13 1 * *'   # 1st of the month 13:23 UTC, before Fabled and Divinity
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'Only compute and print the version'
+        type: boolean
+        default: false
+
+permissions:
+  contents: write
+  pull-requests: read
 
 jobs:
   deploy:
-    uses: magemonkeystudio/.github/.github/workflows/reusable-build.yml@main
+    uses: magemonkeystudio/.github/.github/workflows/reusable-semver-build.yml@main
     secrets: inherit
     with:
-      is_dev: false
+      mode: release
+      release_branch: main
+      dry_run: ${{ inputs.dry_run || false }}
       build_spigot: true
       java_version: '25'
       artifact_filter: 'codex'

.github/workflows/semver-label.yml

@@ -0,0 +1,11 @@
+name: Semver Label
+
+# Every PR into dev needs exactly one of: build:major, build:minor, build:patch
+on:
+  pull_request:
+    types: [ opened, reopened, labeled, unlabeled, synchronize ]
+    branches: [ dev ]
+
+jobs:
+  label:
+    uses: magemonkeystudio/.github/.github/workflows/reusable-semver-label.yml@main

.gitignore

@@ -7,4 +7,5 @@ settings.xml
 toolchains.xml
 log.txt
 logs/
-**/build/*.jar
+**/build/*.jar
+.flattened-pom.xml

README.md

@@ -1,11 +1,15 @@
-[![Build](https://github.com/magemonkeystudios/codex/actions/workflows/release.yml/badge.svg?branch=main)](https://repo.travja.dev/releases/studio/magemonkey/codex/1.2.0-R0.7-SNAPSHOT)
-[![Build](https://github.com/magemonkeystudios/codex/actions/workflows/devbuild.yml/badge.svg?branch=dev)](https://repo.travja.dev/snapshots/studio/magemonkey/codex/1.2.0-R0.7-SNAPSHOT)
+[![Release](https://img.shields.io/github/v/release/magemonkeystudio/codex?label=release)](https://github.com/magemonkeystudio/codex/releases/latest)
+[![Release Build](https://github.com/magemonkeystudio/codex/actions/workflows/release.yml/badge.svg?branch=dev)](https://github.com/magemonkeystudio/codex/actions/workflows/release.yml)
+[![Dev](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.travja.dev%2Fsnapshots%2Fstudio%2Fmagemonkey%2Fcodex%2Fmaven-metadata.xml&strategy=highestVersion&label=dev)](https://repo.travja.dev/#/snapshots/studio/magemonkey/codex)
+[![Dev Build](https://github.com/magemonkeystudio/codex/actions/workflows/devbuild.yml/badge.svg?branch=dev)](https://github.com/magemonkeystudio/codex/actions/workflows/devbuild.yml)
 [![Discord](https://dcbadge.limes.pink/api/server/mQrkW4htUA?style=flat)](https://discord.gg/mQrkW4htUA)
 
 # Codex (Formerly ProMCCore)
 
 If you wish to use Codex as a dependency in your projects, Codex is available through our repository at [repo.travja.dev](https://repo.travja.dev).
 
+Use the latest release version shown above, or `X.Y.Z-SNAPSHOT` (the next release) for the weekly dev build.
+
 ```xml
 <repository>
     <id>magemonkey-snapshots</id>
@@ -15,7 +19,7 @@ If you wish to use Codex as a dependency in your projects, Codex is available th
 <dependency>
     <groupId>studio.magemonkey</groupId>
     <artifactId>codex</artifactId>
-    <version>1.2.0-R0.7-SNAPSHOT</version>
+    <version>VERSION</version>
 </dependency>
 ```
 

codex-api/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>studio.magemonkey</groupId>
         <artifactId>codex-parent</artifactId>
-        <version>1.2.0-R0.8-SNAPSHOT</version>
+        <version>${revision}${changelist}</version>
     </parent>
 
     <artifactId>codex-api</artifactId>

codex-api/src/main/java/studio/magemonkey/codex/api/items/providers/ItemsAdderProvider.java

@@ -82,7 +82,7 @@ public Category getCategory() {
 
         @Override
         public ItemStack create() {
-            return this.customStack.getItemStack();
+            return this.customStack.getItemStack().clone();
         }
 
         @Override

codex-bungee/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>studio.magemonkey</groupId>
         <artifactId>codex-parent</artifactId>
-        <version>1.2.0-R0.8-SNAPSHOT</version>
+        <version>${revision}${changelist}</version>
     </parent>
 
     <artifactId>codex-bungee</artifactId>

codex-core/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>studio.magemonkey</groupId>
         <artifactId>codex-parent</artifactId>
-        <version>1.2.0-R0.8-SNAPSHOT</version>
+        <version>${revision}${changelist}</version>
     </parent>
 
     <artifactId>codex-core</artifactId>

codex-plugin/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>studio.magemonkey</groupId>
         <artifactId>codex-parent</artifactId>
-        <version>1.2.0-R0.8-SNAPSHOT</version>
+        <version>${revision}${changelist}</version>
     </parent>
 
     <artifactId>codex</artifactId>

doc/README.md

@@ -1,11 +1,15 @@
-[![Build](https://github.com/magemonkeystudios/codex/actions/workflows/release.yml/badge.svg?branch=main)](https://repo.travja.dev/releases/studio/magemonkey/codex/${project.version})
-[![Build](https://github.com/magemonkeystudios/codex/actions/workflows/devbuild.yml/badge.svg?branch=dev)](https://repo.travja.dev/snapshots/studio/magemonkey/codex/${project.version})
+[![Release](https://img.shields.io/github/v/release/magemonkeystudio/${project.artifactId}?label=release)](https://github.com/magemonkeystudio/${project.artifactId}/releases/latest)
+[![Release Build](https://github.com/magemonkeystudio/${project.artifactId}/actions/workflows/release.yml/badge.svg?branch=dev)](https://github.com/magemonkeystudio/${project.artifactId}/actions/workflows/release.yml)
+[![Dev](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.travja.dev%2Fsnapshots%2Fstudio%2Fmagemonkey%2F${project.artifactId}%2Fmaven-metadata.xml&strategy=highestVersion&label=dev)](https://repo.travja.dev/#/snapshots/studio/magemonkey/${project.artifactId})
+[![Dev Build](https://github.com/magemonkeystudio/${project.artifactId}/actions/workflows/devbuild.yml/badge.svg?branch=dev)](https://github.com/magemonkeystudio/${project.artifactId}/actions/workflows/devbuild.yml)
 [![Discord](https://dcbadge.limes.pink/api/server/mQrkW4htUA?style=flat)](https://discord.gg/mQrkW4htUA)
 
 # Codex (Formerly ProMCCore)
 
 If you wish to use Codex as a dependency in your projects, Codex is available through our repository at [repo.travja.dev](https://repo.travja.dev).
 
+Use the latest release version shown above, or `X.Y.Z-SNAPSHOT` (the next release) for the weekly dev build.
+
 ```xml
 <repository>
     <id>magemonkey-snapshots</id>
@@ -15,7 +19,7 @@ If you wish to use Codex as a dependency in your projects, Codex is available th
 <dependency>
     <groupId>${project.groupId}</groupId>
     <artifactId>codex</artifactId>
-    <version>${project.version}</version>
+    <version>VERSION</version>
 </dependency>
 ```
 

pom.xml

@@ -11,7 +11,10 @@
     </parent>
 
     <artifactId>codex-parent</artifactId>
-    <version>1.2.0-R0.8-SNAPSHOT</version>
+    <!-- CI sets both properties (-Drevision=X.Y.Z, -Dchangelist=-SNAPSHOT or empty) from the
+         last release tag and PR labels; the values in <properties> are only for local builds.
+         The modules' <parent> versions use the same two properties. -->
+    <version>${revision}${changelist}</version>
     <packaging>pom</packaging>
     <name>CodexParent</name>
     <description>The core plugin for VoidEdge plugins</description>
@@ -24,6 +27,8 @@
     </modules>
 
     <properties>
+        <revision>1.2.0</revision>
+        <changelist>-SNAPSHOT</changelist>
         <delombok.dir>${project.build.directory}/javadoc-delombok</delombok.dir>
     </properties>
 
@@ -190,6 +195,32 @@
                     </execution>
                 </executions>
             </plugin>
+            <!-- Writes the resolved version into the published pom instead of ${revision}${changelist} -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>flatten-maven-plugin</artifactId>
+                <version>1.7.3</version>
+                <configuration>
+                    <updatePomFile>true</updatePomFile>
+                    <flattenMode>resolveCiFriendliesOnly</flattenMode>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>flatten</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>flatten</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>flatten-clean</id>
+                        <phase>clean</phase>
+                        <goals>
+                            <goal>clean</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>