summaryrefslogtreecommitdiff
path: root/website/src/docs
diff options
context:
space:
mode:
Diffstat (limited to 'website/src/docs')
-rw-r--r--website/src/docs/developers/resource.md6
-rw-r--r--website/src/docs/features/admin.md1
2 files changed, 5 insertions, 2 deletions
diff --git a/website/src/docs/developers/resource.md b/website/src/docs/developers/resource.md
index 543365d..67e6d57 100644
--- a/website/src/docs/developers/resource.md
+++ b/website/src/docs/developers/resource.md
@@ -14,7 +14,9 @@ A Gradle multi-module setup shares `engine` while building and releasing Paper /
- `platform-velocity` — `version = velocityVersion`. `api(project(":engine"))`. velocity-api as `compileOnly`. Output is **`LunaticChat-<ver>-velocity.jar`** (distinguished by classifier)
- `dokka` — aggregates engine/paper/velocity and includes the README in the HTML
-Both platforms' `processResources` compute `version` / `gitCommitHash` / `channel` from the git short hash and `isNightly`, and token-expand them into `paper-plugin.yml` / `velocity-plugin.json` and `build-info.properties`.
+Both platforms derive their version from `isNightly`: with `-PisNightly=true` the base version gains a `-nightly.<git short hash>` suffix, so a development build is never mistakable for the release of the same base version (`LunaticChat-1.3.0-nightly.44132f3.jar`). Without the flag the version stays the bare `paperVersion` / `velocityVersion`, which is what the release workflows build.
+
+`processResources` then token-expands `version` / `gitCommitHash` / `channel` into `paper-plugin.yml` / `velocity-plugin.json` and `build-info.properties`.
## Independent versioning
@@ -44,7 +46,7 @@ The release target switches based on the tag pattern.
`ci.yaml` runs on push to main / PR / manual dispatch.
-- `build_plugin` — ktlintCheck → test + jacocoTestReport → upload to Codecov → nightly shadowJar (`-PisNightly=true`) → retain artifacts
+- `build_plugin` — ktlintCheck → test + jacocoTestReport → upload to Codecov → nightly shadowJar (`-PisNightly=true`) → retain artifacts as `LunaticChat-paper-<sha>` / `LunaticChat-velocity-<sha>` (one per platform, each holding the JAR at the archive root)
- `build_dokka` / `deploy_dokka` — generate Dokka → deploy to GitHub Pages (main push only)
- `build_docs` — format/lint/build `website/` with bun → deploy to Cloudflare Workers (wrangler) (main push only)
diff --git a/website/src/docs/features/admin.md b/website/src/docs/features/admin.md
index 531f2e0..aa298ba 100644
--- a/website/src/docs/features/admin.md
+++ b/website/src/docs/features/admin.md
@@ -72,6 +72,7 @@ checkForUpdates: true
Builds produced from the `main` branch outside of a release are marked as nightly, and the plugin says so rather than letting it go unnoticed.
+- The version carries a `-nightly.<commit hash>` suffix (`1.3.0-nightly.44132f3`), so the JAR file name, `/plugins` and `/lc status` all tell it apart from the 1.3.0 release
- Every player is warned on join that the build may be unstable, along with a pointer to GitHub Issues
- `/lc status` shows the same warning, and displays the release channel in yellow instead of green