Team-EnderIO/EnderIO

Fork 0

chore: buildscript cleanup #1166

Open

dphaldes wants to merge 1 commit from chore/clean-buildscript into dev/1.21.1

dphaldes commented

2025-10-08 23:08:22 +00:00

(Migrated from github.com)

Description

clean gradle buildscript for readability and consistency

Checklist

My code follows the style guidelines of this project (.editorconfig, most IDEs will use this for you).
I have made corresponding changes to the documentation.
My changes are ready for review from a contributor.

Summary by CodeRabbit

New Features
- Added dedicated gametest and datagen build configurations.
- More consistent release channel detection (alpha/beta/release/dev) reflected in build versions.
Refactor
- Centralised and simplified Gradle configuration and classpath wiring for tests and runtime.
Chores
- Enabled Gradle build cache to speed up builds.
- Removed explicit Java 21 toolchain targeting to align configurations across modules.

# Description clean gradle buildscript for readability and consistency # Checklist - [x] My code follows the style guidelines of this project (.editorconfig, most IDEs will use this for you). - [x] I have made corresponding changes to the documentation. - [x] My changes are ready for review from a contributor.  ## Summary by CodeRabbit - New Features - Added dedicated gametest and datagen build configurations. - More consistent release channel detection (alpha/beta/release/dev) reflected in build versions. - Refactor - Centralised and simplified Gradle configuration and classpath wiring for tests and runtime. - Chores - Enabled Gradle build cache to speed up builds. - Removed explicit Java 21 toolchain targeting to align configurations across modules.

coderabbitai[bot] commented

2025-10-08 23:08:38 +00:00

(Migrated from github.com)

Walkthrough

PR updates Gradle build logic: consolidates and extends configurations (including gametest and datagen), adds a new localRuntime and wiring, removes explicit Java 21 toolchains in selected modules, changes getReleaseType() to return non-null with revised parsing, tweaks tag version extraction in buildSrc, and enables Gradle build cache.

Changes

Cohort / File(s)	Summary
Release type: non-null and parsing update `build.gradle.kts`, `enderio/build.gradle.kts` (...two occurrences), `enderio-endergy/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts`	Change `getReleaseType()` from `String?` to `String`; normalise env var once; use `contains("alpha"/"beta")`; return `"release"` when set but unmatched, else `"dev"`. Variable renamed `version_string` → `versionString`.
Configurations refactor: centralised wiring, gametest, datagen `enderio/build.gradle.kts`, `enderio-endergy/build.gradle.kts`, `enderio-armory/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts`	Introduce/centralise `configurations { ... }`; add `localRuntime` and extend `runtimeClasspath`; add/wire `gametest` configs and dependency; add/wire `datagen` in relevant modules; migrate existing extendsFrom/exclusions into the block; relocate `gametestImplementation` retrieval where applicable.
Java toolchain removal (Java 21) `endercore/build.gradle.kts`, `enderio-armory/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts`	Remove explicit Java toolchain language version configuration.
Tag version extraction cleanup `buildSrc/src/main/kotlin/mod-common-conventions.gradle.kts`	Remove top-level `versionRegex`; make `tagVersion` an immutable `val` using inline `Regex` on `details.lastTag`.
Build cache enablement `gradle.properties`	Add `org.gradle.build-cache=true`.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Env as Environment
  participant Gradle as Gradle Script
  participant Func as getReleaseType()

  Env->>Func: BUILD_VERSION
  Note over Func: Lowercase once into versionString
  alt BUILD_VERSION unset
    Func-->>Gradle: "dev"
  else BUILD_VERSION set
    alt contains "alpha"
      Func-->>Gradle: "alpha"
    else contains "beta"
      Func-->>Gradle: "beta"
    else no match
      Func-->>Gradle: "release"
    end
  end

sequenceDiagram
  autonumber
  participant G as Gradle
  participant C as configurations { ... }
  participant RT as runtimeClasspath
  participant LR as localRuntime
  participant GT as gametest*
  participant DG as datagen*

  G->>C: Define LR, GT, DG
  C->>RT: extendsFrom(LR)
  C->>GT: derive from base compile/impl/runtime/AP
  C->>DG: derive from main/test/AP as specified
  G->>GT: dependencies { gametestImplementation(neoforge-gametest) }
  Note over G,RT: Resolved classpaths include LR and specialised GT/DG graphs

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Suggested labels

MC-1.21.1

Poem

A carrot of cache in the burrow I stash,
Configs hop neatly—no scatter, no clash.
Alpha or beta? I sniff and I see,
If none, it’s release—so certain, so free.
Toolchains pruned, vines of deps entwine—
Thump-thump! This build now runs just fine. 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description includes a brief summary and the checklist but omits the required “Breaking Changes” section from the repository template, leaving it unclear whether any incompatible changes have been introduced.	Please add a “# Breaking Changes” section to explicitly state any breaking changes or indicate “None” if there are none, ensuring the description matches the repository’s template structure.
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly summarises the primary intent of the changeset by indicating a chore-level cleanup of the build scripts, using a conventional prefix and clear phrasing that matches the pull request’s focus on readability and consistency.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/clean-buildscript

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd7d0477d4 and 1517687ddd.

📒 Files selected for processing (8)

build.gradle.kts (1 hunks)
buildSrc/src/main/kotlin/mod-common-conventions.gradle.kts (1 hunks)
endercore/build.gradle.kts (0 hunks)
enderio-armory/build.gradle.kts (2 hunks)
enderio-endergy/build.gradle.kts (2 hunks)
enderio-modded-conduits/build.gradle.kts (3 hunks)
enderio/build.gradle.kts (3 hunks)
gradle.properties (1 hunks)

💤 Files with no reviewable changes (1)

endercore/build.gradle.kts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Analyze (java-kotlin)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

## Walkthrough PR updates Gradle build logic: consolidates and extends configurations (including gametest and datagen), adds a new localRuntime and wiring, removes explicit Java 21 toolchains in selected modules, changes getReleaseType() to return non-null with revised parsing, tweaks tag version extraction in buildSrc, and enables Gradle build cache. ## Changes | Cohort / File(s) | Summary | |---|---| | **Release type: non-null and parsing update** `build.gradle.kts`, `enderio/build.gradle.kts` (...two occurrences), `enderio-endergy/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts` | Change `getReleaseType()` from `String?` to `String`; normalise env var once; use `contains("alpha"/"beta")`; return `"release"` when set but unmatched, else `"dev"`. Variable renamed `version_string` → `versionString`. | | **Configurations refactor: centralised wiring, gametest, datagen** `enderio/build.gradle.kts`, `enderio-endergy/build.gradle.kts`, `enderio-armory/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts` | Introduce/centralise `configurations { ... }`; add `localRuntime` and extend `runtimeClasspath`; add/wire `gametest*` configs and dependency; add/wire `datagen*` in relevant modules; migrate existing extendsFrom/exclusions into the block; relocate `gametestImplementation` retrieval where applicable. | | **Java toolchain removal (Java 21)** `endercore/build.gradle.kts`, `enderio-armory/build.gradle.kts`, `enderio-modded-conduits/build.gradle.kts` | Remove explicit Java toolchain language version configuration. | | **Tag version extraction cleanup** `buildSrc/src/main/kotlin/mod-common-conventions.gradle.kts` | Remove top-level `versionRegex`; make `tagVersion` an immutable `val` using inline `Regex` on `details.lastTag`. | | **Build cache enablement** `gradle.properties` | Add `org.gradle.build-cache=true`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram autonumber actor Env as Environment participant Gradle as Gradle Script participant Func as getReleaseType() Env->>Func: BUILD_VERSION Note over Func: Lowercase once into versionString alt BUILD_VERSION unset Func-->>Gradle: "dev" else BUILD_VERSION set alt contains "alpha" Func-->>Gradle: "alpha" else contains "beta" Func-->>Gradle: "beta" else no match Func-->>Gradle: "release" end end ``` ```mermaid sequenceDiagram autonumber participant G as Gradle participant C as configurations { ... } participant RT as runtimeClasspath participant LR as localRuntime participant GT as gametest* participant DG as datagen* G->>C: Define LR, GT, DG C->>RT: extendsFrom(LR) C->>GT: derive from base compile/impl/runtime/AP C->>DG: derive from main/test/AP as specified G->>GT: dependencies { gametestImplementation(neoforge-gametest) } Note over G,RT: Resolved classpaths include LR and specialised GT/DG graphs ``` ## Estimated code review effort 🎯 4 (Complex) | ⏱️ ~60 minutes ## Suggested labels `MC-1.21.1` ## Poem > A carrot of cache in the burrow I stash, > Configs hop neatly—no scatter, no clash. > Alpha or beta? I sniff and I see, > If none, it’s release—so certain, so free. > Toolchains pruned, vines of deps entwine— > Thump-thump! This build now runs just fine. 🥕🐇   ## Pre-merge checks and finishing touches <details> <summary>❌ Failed checks (2 warnings)</summary> | Check name | Status | Explanation | Resolution | | :----------------: | :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Description Check | ⚠️ Warning | The description includes a brief summary and the checklist but omits the required “Breaking Changes” section from the repository template, leaving it unclear whether any incompatible changes have been introduced. | Please add a “# Breaking Changes” section to explicitly state any breaking changes or indicate “None” if there are none, ensuring the description matches the repository’s template structure. | | Docstring Coverage | ⚠️ Warning | Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. | You can run `@coderabbitai generate docstrings` to improve docstring coverage. | </details> <details> <summary>✅ Passed checks (1 passed)</summary> | Check name | Status | Explanation | | :---------: | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Title Check | ✅ Passed | The title succinctly summarises the primary intent of the changeset by indicating a chore-level cleanup of the build scripts, using a conventional prefix and clear phrasing that matches the pull request’s focus on readability and consistency. | </details>   <details> <summary>✨ Finishing touches</summary> - [ ]  📝 Generate docstrings <details> <summary>🧪 Generate unit tests (beta)</summary> - [ ]  Create PR with unit tests - [ ]  Post copyable unit tests in a comment - [ ]  Commit unit tests in branch `chore/clean-buildscript` </details> </details>  --- <details> <summary>📜 Recent review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between bd7d0477d42e2a1ff7b5691b4b8ab21012cfbab7 and 1517687ddd6e3d5550108c29064de1b5eabae2c0. </details> <details> <summary>📒 Files selected for processing (8)</summary> * `build.gradle.kts` (1 hunks) * `buildSrc/src/main/kotlin/mod-common-conventions.gradle.kts` (1 hunks) * `endercore/build.gradle.kts` (0 hunks) * `enderio-armory/build.gradle.kts` (2 hunks) * `enderio-endergy/build.gradle.kts` (2 hunks) * `enderio-modded-conduits/build.gradle.kts` (3 hunks) * `enderio/build.gradle.kts` (3 hunks) * `gradle.properties` (1 hunks) </details> <details> <summary>💤 Files with no reviewable changes (1)</summary> * endercore/build.gradle.kts </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)</summary> * GitHub Check: Analyze (java-kotlin) </details> </details>  --- Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> Comment `@coderabbitai help` to get the list of available commands and usage tips.

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin chore/clean-buildscript:chore/clean-buildscript

git switch chore/clean-buildscript

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch dev/1.21.1

git merge --no-ff chore/clean-buildscript

git switch chore/clean-buildscript

git rebase dev/1.21.1

git switch dev/1.21.1

git merge --ff-only chore/clean-buildscript

git switch chore/clean-buildscript

git rebase dev/1.21.1

git switch dev/1.21.1

git merge --no-ff chore/clean-buildscript

git switch dev/1.21.1

git merge --squash chore/clean-buildscript