Refactor ConventionsPlugin class #20805
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* | ||
| * Copyright 2012-2020 the original author or authors. | ||
| * | ||
| * Licensed 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. | ||
| */ | ||
|
|
||
| package org.springframework.boot.build; | ||
|
|
||
| import org.apache.maven.artifact.repository.MavenArtifactRepository; | ||
| import org.gradle.api.Plugin; | ||
| import org.gradle.api.Project; | ||
| import org.gradle.api.plugins.JavaPlugin; | ||
| import org.gradle.api.plugins.JavaPluginExtension; | ||
| import org.gradle.api.publish.PublishingExtension; | ||
| import org.gradle.api.publish.maven.MavenPom; | ||
| import org.gradle.api.publish.maven.MavenPomDeveloperSpec; | ||
| import org.gradle.api.publish.maven.MavenPomIssueManagement; | ||
| import org.gradle.api.publish.maven.MavenPomLicenseSpec; | ||
| import org.gradle.api.publish.maven.MavenPomOrganization; | ||
| import org.gradle.api.publish.maven.MavenPomScm; | ||
| import org.gradle.api.publish.maven.MavenPublication; | ||
| import org.gradle.api.publish.maven.plugins.MavenPublishPlugin; | ||
|
|
||
| /** | ||
| * Plugin to apply Maven Publishing conventions to projects that are part of Spring Boot's | ||
| * build. Conventions are applied in response to various plugins being applied. | ||
| * | ||
| * When the {@link MavenPublishPlugin Maven Publish plugin} is applied: | ||
| * | ||
| * <ul> | ||
| * <li>If the {@code deploymentRepository} property has been set, a | ||
| * {@link MavenArtifactRepository Maven artifact repository} is configured to publish to | ||
| * it. | ||
| * <li>The poms of all {@link MavenPublication Maven publications} are customized to meet | ||
| * Maven Central's requirements. | ||
| * <li>If the {@link JavaPlugin Java plugin} has also been applied, creation of Javadoc | ||
| * and source jars is enabled. | ||
| * </ul> | ||
| * | ||
| * <p/> | ||
| * | ||
| * @author Mike Smithson | ||
| */ | ||
| public class MavenPomConventions implements Plugin<Project> { | ||
|
There was a problem hiding this comment. This class doesn't need to be a There was a problem hiding this comment. This class applies more than pom conventions. I think |
||
|
|
||
| @Override | ||
| public void apply(Project project) { | ||
| project.getPlugins().withType(MavenPublishPlugin.class).all((mavenPublish) -> { | ||
| PublishingExtension publishing = project.getExtensions().getByType(PublishingExtension.class); | ||
| if (project.hasProperty("deploymentRepository")) { | ||
| publishing.getRepositories().maven((mavenRepository) -> { | ||
| mavenRepository.setUrl(project.property("deploymentRepository")); | ||
| mavenRepository.setName("deployment"); | ||
| }); | ||
| } | ||
| publishing.getPublications().withType(MavenPublication.class) | ||
| .all((mavenPublication) -> customizePom(mavenPublication.getPom(), project)); | ||
| project.getPlugins().withType(JavaPlugin.class).all((javaPlugin) -> { | ||
| JavaPluginExtension extension = project.getExtensions().getByType(JavaPluginExtension.class); | ||
| extension.withJavadocJar(); | ||
| extension.withSourcesJar(); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| private void customizePom(MavenPom pom, Project project) { | ||
| pom.getUrl().set("https://projects.spring.io/spring-boot/#"); | ||
| pom.getDescription().set(project.provider(project::getDescription)); | ||
| pom.organization(this::customizeOrganization); | ||
| pom.licenses(this::customizeLicences); | ||
| pom.developers(this::customizeDevelopers); | ||
| pom.scm(this::customizeScm); | ||
| pom.issueManagement(this::customizeIssueManagement); | ||
| } | ||
|
|
||
| private void customizeOrganization(MavenPomOrganization organization) { | ||
| organization.getName().set("Pivotal Software, Inc."); | ||
| organization.getUrl().set("https://spring.io"); | ||
| } | ||
|
|
||
| private void customizeLicences(MavenPomLicenseSpec licences) { | ||
| licences.license((licence) -> { | ||
| licence.getName().set("Apache License, Version 2.0"); | ||
| licence.getUrl().set("http://www.apache.org/licenses/LICENSE-2.0"); | ||
| }); | ||
| } | ||
|
|
||
| private void customizeDevelopers(MavenPomDeveloperSpec developers) { | ||
| developers.developer((developer) -> { | ||
| developer.getName().set("Pivotal"); | ||
| developer.getEmail().set("[email protected]"); | ||
| developer.getOrganization().set("Pivotal Software, Inc."); | ||
| developer.getOrganizationUrl().set("https://www.spring.io"); | ||
| }); | ||
| } | ||
|
|
||
| private void customizeScm(MavenPomScm scm) { | ||
| scm.getConnection().set("scm:git:git://github.com/spring-projects/spring-boot.git"); | ||
| scm.getDeveloperConnection().set("scm:git:ssh://[email protected]/spring-projects/spring-boot.git"); | ||
| scm.getUrl().set("https://github.com/spring-projects/spring-boot"); | ||
|
|
||
| } | ||
|
|
||
| private void customizeIssueManagement(MavenPomIssueManagement issueManagement) { | ||
| issueManagement.getSystem().set("GitHub"); | ||
| issueManagement.getUrl().set("https://github.com/spring-projects/spring-boot/issues"); | ||
| } | ||
|
|
||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The javadoc above should be updated to replace the list of actions when the
MavenPublishPluginis applied and to link to the new Maven conventions class instead.