-
-
Notifications
You must be signed in to change notification settings - Fork 974
Step 1 (PR-F): Add grails-hibernate5-micronaut BOM (Micronaut BOM split) #15689
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jamesfredley
wants to merge
4
commits into
8.0.x
Choose a base branch
from
refactor/micronaut-bom-hibernate-split
base: 8.0.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bdb1e00
Add grails-hibernate5-micronaut BOM (Micronaut BOM split)
jdaugherty 35527d8
Address Copilot review feedback on the Micronaut BOM split
jdaugherty a16b453
Merge remote-tracking branch 'origin/8.0.x' into refactor/micronaut-b…
jamesfredley 31ec106
fix(bom): exclude tools.jackson from grails-hibernate5-micronaut-bom …
jamesfredley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import org.apache.grails.gradle.tasks.bom.ExtractDependenciesTask | ||
| import org.apache.grails.gradle.tasks.bom.ExtractedDependencyConstraint | ||
| import org.apache.grails.gradle.tasks.bom.PropertyNameCalculator | ||
|
|
||
| buildscript { | ||
| apply from: rootProject.layout.projectDirectory.file('dependencies.gradle') | ||
| } | ||
|
|
||
| plugins { | ||
| id 'java-platform' | ||
| id 'org.apache.grails.buildsrc.publish' | ||
| id 'org.apache.grails.buildsrc.sbom' | ||
| } | ||
|
|
||
| version = projectVersion | ||
| group = 'org.apache.grails' | ||
|
|
||
| javaPlatform { | ||
| allowDependencies() | ||
| } | ||
|
|
||
| ext { | ||
| isReleaseBuild = System.getenv('GRAILS_PUBLISH_RELEASE') == 'true' | ||
| isPublishedExternal = System.getenv().containsKey('NEXUS_PUBLISH_STAGING_PROFILE_ID') | ||
| // TODO: It should be possible to pull these build names using includedBuild, but I haven't found a way to do so | ||
| gradleBuildProjects = [ | ||
| 'grails-gradle-plugins':'org.apache.grails', | ||
| 'grails-gradle-model':'org.apache.grails.gradle', | ||
| 'grails-gradle-common':'org.apache.grails.gradle', | ||
| 'grails-gradle-tasks':'org.apache.grails', | ||
| ] | ||
| } | ||
|
|
||
| // Register the Micronaut platform in combinedPlatforms/combinedVersions so | ||
| // PropertyNameCalculator (used by extractConstraints and pomCustomization) can | ||
| // resolve a property name for the micronaut-platform constraint. | ||
| project.ext.combinedPlatforms = combinedPlatforms + ['micronaut-platform': "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion".toString()] | ||
| project.ext.combinedVersions = combinedVersions + ['micronaut-platform.version': micronautPlatformVersion as String] | ||
|
|
||
| // Coordinates we override via customBomDependencies — these must be excluded from the | ||
| // inherited platform chain so they don't conflict with our strictly-versioned overrides | ||
| // when consumers apply this BOM via enforcedPlatform. | ||
| def overriddenModules = customBomDependencies.values().collect { String coord -> | ||
| def parts = coord.split(':') | ||
| [group: parts[0], module: parts[1]] | ||
| } | ||
| Set<String> overriddenCoords = overriddenModules.collect { "${it.group}:${it.module}".toString() } as Set | ||
|
|
||
| dependencies { | ||
| api(platform(project(':grails-base-bom'))) { | ||
| overriddenModules.each { ovr -> | ||
| exclude group: ovr.group, module: ovr.module | ||
| } | ||
| } | ||
|
|
||
| // Re-export the Micronaut platform so consumers inherit Micronaut's managed versions | ||
| // transitively. Exclude Groovy since we declare the required version explicitly via | ||
| // customBomDependencies. Exclude Spock since we manage that version ourselves. | ||
| api(platform("io.micronaut.platform:micronaut-platform:$micronautPlatformVersion")) { | ||
| exclude group: 'org.apache.groovy' | ||
| exclude group: 'org.spockframework' | ||
| } | ||
|
|
||
| constraints { | ||
| // Re-declare base BOM constraints directly so enforcedPlatform() consumers | ||
| // get forced versions. Constraints inherited via platform() are not enforced | ||
| // by enforcedPlatform — only direct constraints are. | ||
| // Skip entries we override below in customBomDependencies to avoid conflicting | ||
| // strictly constraints under enforcedPlatform. | ||
| gradleBomDependencies.values().each { String coord -> | ||
| def parts = coord.split(':') | ||
| String key = parts[0] + ':' + parts[1] | ||
| if (key in overriddenCoords) { | ||
| return | ||
| } | ||
| api coord | ||
| } | ||
| bomDependencies.values().each { String coord -> | ||
| def parts = coord.split(':') | ||
| String key = parts[0] + ':' + parts[1] | ||
| if (key in overriddenCoords) return | ||
| api coord | ||
| } | ||
| for (def entry : bomPlatformDependencies.entrySet()) { | ||
| api entry.value | ||
| } | ||
| // Re-declare the Micronaut platform as a constraint for enforcedPlatform support | ||
| api "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion" | ||
| for (def entry : customBomDependencies.entrySet()) { | ||
| def parts = entry.value.split(':') | ||
| if (parts.length == 3) { | ||
| api("${parts[0]}:${parts[1]}") { | ||
| version { | ||
| strictly parts[2] | ||
| } | ||
| } | ||
| } else { | ||
| api entry.value | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| configurations.register('bomDependencies').configure { | ||
| it.canBeResolved = true | ||
| it.transitive = true | ||
| it.extendsFrom(configurations.named('api').get()) | ||
| } | ||
|
|
||
| tasks.register('extractConstraints', ExtractDependenciesTask).configure { ExtractDependenciesTask it -> | ||
| it.captureProjectServices(project.dependencies, project.configurations) | ||
| it.configuration = configurations.named('bomDependencies') | ||
| it.configurationName = 'bomDependencies' | ||
| it.destination = project.layout.buildDirectory.file('grails-hibernate5-micronaut-bom-constraints.adoc') | ||
| it.platformDefinitions = combinedPlatforms | ||
| it.definitions = combinedDependencies | ||
| it.projectName = project.name | ||
| it.versions = combinedVersions | ||
| // Micronaut's platform imports many sub-BOMs (micronaut-*-bom, netty-bom, etc.) that are | ||
| // not explicitly registered in dependencies.gradle. Auto-register them so extractConstraints | ||
| // can document their versions without requiring manual entries for every transitive platform. | ||
| // this is required because the micronaut bom format uses gradle modules instead of a pom like spring boot | ||
| it.autoRegisterTransitivePlatforms = true | ||
| rootProject.subprojects.each { p -> | ||
| evaluationDependsOn(p.path) | ||
| } | ||
| it.projectArtifactIds.set(project.provider { | ||
| Map<String, String> artifactIdMappings = [:] | ||
|
|
||
| rootProject.subprojects.each { p -> | ||
| artifactIdMappings[p.name] = p.findProperty('pomArtifactId') ?: p.name | ||
| } | ||
|
|
||
| for (Map.Entry<String, String> dependency : project.ext.gradleBuildProjects.entrySet()) { | ||
| artifactIdMappings[dependency.key] = dependency.key | ||
| } | ||
|
|
||
| artifactIdMappings | ||
| }) | ||
| it.forcedGroupPrefixes.set(['org.apache.grails.profiles': 'grails-profile']) | ||
| it.projectCoordinateProperties.set(project.provider { | ||
| Map<String, String> projectCoordinates = [:] | ||
|
|
||
| rootProject.subprojects.each { p -> | ||
| String artifactId = p.findProperty('pomArtifactId') as String ?: p.name | ||
| String baseVersionName = artifactId.replaceAll('[.]', '-') | ||
| projectCoordinates["${p.group}:${artifactId}:${p.version}" as String] = baseVersionName | ||
| } | ||
|
|
||
| for (Map.Entry<String, String> dependency : project.ext.gradleBuildProjects.entrySet()) { | ||
| projectCoordinates["${dependency.value}:${dependency.key}:${project.version}" as String] = dependency.key | ||
| } | ||
|
|
||
| projectCoordinates | ||
| }) | ||
|
|
||
| it.dependsOn(project.tasks.named('generateMetadataFileForMavenPublication'), project.tasks.named('generatePomFileForMavenPublication')) | ||
| } | ||
|
|
||
| def validateNoSnapshotDependencies = tasks.register('validateNoSnapshotDependencies') | ||
| validateNoSnapshotDependencies.configure { Task it -> | ||
| it.group = 'publishing' | ||
| it.description = 'Validates that no snapshot dependencies are present in the project when performing a release.' | ||
|
|
||
| it.doLast { | ||
| configurations.each { config -> | ||
| config.allDependencies.each { dep -> | ||
| if (dep.version && dep.version.contains('-SNAPSHOT')) { | ||
| throw new GradleException("Releases cannot have a snapshot dependency: ${dep.group}:${dep.name} (${dep.version})") | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (ext.isReleaseBuild && ext.isPublishedExternal) { | ||
| project.afterEvaluate { | ||
| tasks.named('generateMetadataFileForMavenPublication').configure { | ||
| dependsOn(validateNoSnapshotDependencies) | ||
| } | ||
| tasks.named('generatePomFileForMavenPublication').configure { | ||
| dependsOn(validateNoSnapshotDependencies) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| ext { | ||
| pomDescription = 'Grails Hibernate 5 Micronaut BOM (Bill of Materials) for Grails projects integrating with Micronaut and Hibernate 5. Layers Hibernate 5 dependency management on top of grails-micronaut-bom; consume as enforcedPlatform.' | ||
| pomCustomization = { xml -> | ||
| def root = xml.asNode() | ||
|
|
||
| def propertiesNode = root.properties ? root.properties[0] : root.appendNode('properties') | ||
|
|
||
| def depMgmt = root.dependencyManagement?.getAt(0) | ||
| def deps = depMgmt?.dependencies?.getAt(0) | ||
| if (deps) { | ||
| PropertyNameCalculator propertyNameCalculator = new PropertyNameCalculator(combinedPlatforms, combinedDependencies, combinedVersions) | ||
| propertyNameCalculator.addForcedGroupPrefix('org.apache.grails.profiles', 'grails-profile') | ||
| propertyNameCalculator.addProjects(rootProject.subprojects) | ||
| for (String gradleArtifactId : project.ext.gradleBuildProjects) { | ||
| propertyNameCalculator.addProject('org.apache.grails.gradle', gradleArtifactId, project.version as String, gradleArtifactId) | ||
| } | ||
|
|
||
| Map<String, String> pomProperties = [:] | ||
| deps.dependency.each { dep -> | ||
| String groupId = dep.groupId.text().trim() | ||
| String artifactId = dep.artifactId.text().trim() | ||
| boolean isBom = dep.scope.text().trim() == 'import' | ||
|
|
||
| String inlineVersion = dep.version.text().trim() | ||
| if (inlineVersion == 'null') { | ||
| inlineVersion = null | ||
| } | ||
|
|
||
| if (inlineVersion) { | ||
| ExtractedDependencyConstraint extractedConstraint = propertyNameCalculator.calculate(groupId, artifactId, inlineVersion, isBom) | ||
| if (extractedConstraint?.versionPropertyReference) { | ||
| // use the property reference instead of the hard coded version so that it can be | ||
| // overridden by the spring boot dependency management plugin | ||
| dep.version[0].value = extractedConstraint.versionPropertyReference | ||
|
|
||
| // Add an entry in the <properties> node with the actual version number | ||
| pomProperties.put(extractedConstraint.versionPropertyName, inlineVersion) | ||
| } | ||
| } else if (!inlineVersion) { | ||
| throw new GradleException("Dependency $groupId:$artifactId does not have a version.") | ||
| } | ||
| } | ||
|
|
||
| for (Map.Entry<String, String> property : pomProperties.entrySet()) { | ||
| propertiesNode.appendNode(property.key, property.value) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.