Simplify generated build #424

jamesfredley · 2024-11-11T00:08:25Z

This was significantly more involved than anticipated.

This PR:

Addresses the 5 linked issues
Consolidates Gradle Plugin configuration to buildscript{}, plugins{} and apply plugin: in build.gradle
Changes Gradle buildSrc/build.gradle and Settings File to non-default, optional features
When the Gradle Settings File feature is selected, it only contains one line defining the root project
When the Gradle buildSrc feature is selected buildscript{} is not generated, they are equivalent
Works around org.grails.grails-web & org.grails.grails-gsp Gradle Plugin ids with versions not working for snapshots grails-gradle-plugin#351 by using "apply plugin:" for Gradle plugin ids that are not published to the Gradle Plugin repo and are not release versions. Release versions work fine with id and version.
significant updates to fix the tests, including one that was not cross platform compatible
adds classpath scope
updates asset-pipeline to 4.5.1
standardizes on double quotes with no parentheses in build.gradle, did not update web-driver/selenium since it has been removed in 7.0.x
dependencies set to pom will still have parentheses, since they are required for platform()
move hamcrest, micronaut-http-client and neo4j-harness dependencies to features instead of manually being set in dependencies.rocker.raw
remove dependencies.rocker.raw since it duplicates toSnippet()
rename RUNTIME to RUNTIME_ONLY, TEST to TEST_IMPLEMENTATION and
TEST_RUNTIME to TEST_RUNTIME_ONLY to reflect the actual Gradle scopes
rename compile to implementation

Merging up to 7.0.x is going to be fun.

…ile optional features when buildSrc feature is selected buildscript{} will not generate in main build.gradle file

jamesfredley · 2024-11-11T00:39:25Z

This required significant changes to get the desired outcome. We need to debate whether this is completed in 6.2.2 or 7.0.0.

grails/grails-doc#923 - ticket to update documentation.

grails-forge-core/src/main/java/org/grails/forge/feature/assetPipeline/AssetPipeline.java

matrei

This was some heavy lifting, nice work James!

I think there is a risk that doing this big of a change will introduce bugs in 6.2.2. As you say, we should discuss if it is worth the trouble to merge this to 6.2.x.

I'm not sure it's even going to help anyone out, but rather cause more confusion. If a user is on Grails 5 or lower, is there any need to upgrade to Grails 6 before upgrading to Grails 7? If a user is on Grails 6 it should be an easy operation to remove buildSrc when upgrading to Grails 7 (if that is what the user wants).

grails-forge-core/src/main/resources/pom.xml

...rge-core/src/main/java/org/grails/forge/feature/build/gradle/templates/dependency.rocker.raw

grails-forge-core/src/test/groovy/org/grails/forge/feature/lang/GrailsApplicationSpec.groovy

…grails-forge into simplify-generated-build

codeconsole · 2024-11-11T16:09:59Z

I'm not sure it's even going to help anyone out, but rather cause more confusion. If a user is on Grails 5 or lower, is there any need to upgrade to Grails 6 before upgrading to Grails 7? If a user is on Grails 6 it should be an easy operation to remove buildSrc when upgrading to Grails 7 (if that is what the user wants).

@matrei we need to think from the perspective of what is create-app for? Creating new apps.

Why create an overcomplicated build for a new app only for someone to have to dramatically change it in an upcoming release?
Grails <= 6.2.0 was broken. We were just cleaning up an inherited mess and are putting our names behind the release. Let's finish with a more polished product we can be proud of.
This has to be done either way for Grails 7.
This can continue to evolve independently as it is only forge. It does not introduce any bugs or affect 6.2.2 working in any way.
The current behavior is inconsistent with Grails shell. Does Grails shell create-app create a buildSrc?

…o features instead of manually being set in dependencies.rocker.raw remove dependencies.rocker.raw since it duplicates toSnippet() rename RUNTIME to RUNTIME_ONLY, TEST to TEST_IMPLEMENTATION and TEST_RUNTIME to TEST_RUNTIME_ONLY to reflect the actual Gradle scope

matrei · 2024-11-11T21:17:46Z

grails-forge-core/src/main/java/org/grails/forge/build/dependencies/Scope.java

    public static final Scope TEST_ANNOTATION_PROCESSOR = new Scope(Source.TEST, Collections.singletonList(Phase.ANNOTATION_PROCESSING));
    public static final Scope TEST_COMPILE_ONLY = new Scope(Source.TEST, Collections.singletonList(Phase.COMPILATION));
-    public static final Scope TEST_RUNTIME = new Scope(Source.TEST, Collections.singletonList(Phase.RUNTIME));
+    public static final Scope TEST_RUNTIME_ONLY = new Scope(Source.TEST, Collections.singletonList(Phase.RUNTIME));


Should we also add the integrationTest* scopes for completeness. Geb, Selenium and perhaps some others should preferably be moved to those.

And what about renaming compile to implementation?

Good catch, I've renamed compile to implementation.

For integrationTest* scopes, I'd like to do that on the 7.0.x branch since it already has INTEGRATION_TEST_IMPLEMENTATION_TEST_FIXTURES

grails-forge/grails-forge-core/src/main/java/org/grails/forge/build/dependencies/Scope.java

Line 40 in a875736

public static final Scope INTEGRATION_TEST_IMPLEMENTATION_TEST_FIXTURES = new Scope(Source.MAIN, Collections.singletonList(Phase.INTEGRATION_TEST_IMPLEMENTATION_TEST_FIXTURES));

jamesfredley · 2024-11-11T22:51:03Z

I've seen this test fail several times. Deleting build manually gets it working again.

> Task :grails-forge-core:test FAILED

GradleSpec > test buildSrc/build.gradle FAILED
    Condition not satisfied:

    buildSrcGradle
    |
    ""
        at org.grails.forge.build.gradle.GradleSpec.test buildSrc/build.gradle(GradleSpec.groovy:50)

…e same as main build.gradle file this is the only Gradle build dependency that is needed in buildSrc/build.gradle and not in buildscript{}

jamesfredley added 4 commits November 10, 2024 18:58

Update asset-pipeline to 4.5.1

0451e58

remove parenthesis from Gradle dependencies

96f9c18

consolidate Gradle plugin config, make Gradle buildSrc and settings f…

e69382a

…ile optional features when buildSrc feature is selected buildscript{} will not generate in main build.gradle file

fix failing tests after Gradle plugin configuration consolidation

619b84f

grails-build added build maintenance labels Nov 11, 2024

fix failing test after Gradle plugin configuration consolidation

0b75637

jamesfredley mentioned this pull request Nov 11, 2024

Update documentation for buildSrc, buildscript{} and settings.gradle grails/grails-doc#923

Open

jamesfredley requested review from matrei and codeconsole November 11, 2024 00:40

jamesfredley commented Nov 11, 2024

View reviewed changes

grails-forge-core/src/main/java/org/grails/forge/feature/assetPipeline/AssetPipeline.java Show resolved Hide resolved

matrei added 2 commits November 11, 2024 09:58

fix: Tests working on Windows

093b84c

test: Add tests for optional build file features

fad7db8

matrei reviewed Nov 11, 2024

View reviewed changes

jamesfredley added 4 commits November 11, 2024 10:36

Update asset-pipeline to 4.5.2

2747012

Merge branch 'simplify-generated-build' of https://github.com/grails/…

7579cbb

…grails-forge into simplify-generated-build

Update asset-pipeline to 4.5.2 in test

c604a96

Adjust mainClass syntax

23ab1bd

jamesfredley added 3 commits November 11, 2024 11:30

fix spacing when using bom/platform

f1b53a1

back to asset-pipeline 4.5.1

e2186a2

jamesfredley requested a review from matrei November 11, 2024 21:01

matrei approved these changes Nov 11, 2024

View reviewed changes

jamesfredley added 2 commits November 11, 2024 17:51

rename compile to implementation

a6903a1

add grails-bom to buildSrc/build.gradle to set dependency versions th…

f30d3cb

…e same as main build.gradle file this is the only Gradle build dependency that is needed in buildSrc/build.gradle and not in buildscript{}

jamesfredley merged commit a5994bd into 6.2.x Nov 14, 2024
10 checks passed

jamesfredley deleted the simplify-generated-build branch November 14, 2024 22:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify generated build #424

Simplify generated build #424

jamesfredley commented Nov 11, 2024 •

edited

Loading

jamesfredley commented Nov 11, 2024

matrei left a comment •

edited

Loading

codeconsole commented Nov 11, 2024 •

edited

Loading

matrei Nov 11, 2024

jamesfredley Nov 11, 2024

jamesfredley commented Nov 11, 2024

Simplify generated build #424

Simplify generated build #424

Conversation

jamesfredley commented Nov 11, 2024 • edited Loading

jamesfredley commented Nov 11, 2024

matrei left a comment • edited Loading

Choose a reason for hiding this comment

codeconsole commented Nov 11, 2024 • edited Loading

matrei Nov 11, 2024

Choose a reason for hiding this comment

jamesfredley Nov 11, 2024

Choose a reason for hiding this comment

jamesfredley commented Nov 11, 2024

jamesfredley commented Nov 11, 2024 •

edited

Loading

matrei left a comment •

edited

Loading

codeconsole commented Nov 11, 2024 •

edited

Loading