Skip to content
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.

Sign up for GitHub

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

Configure latest released wrapper in new Gradle project #6333

Merged
merged 1 commit into from
Aug 14, 2023
Merged

Configure latest released wrapper in new Gradle project #6333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions extide/gradle/apichanges.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,21 @@ is the proper place.
<!-- ACTUAL CHANGES BEGIN HERE: -->

<changes>
<change id="gradle-wrapper-version">
<api name="general"/>
<summary>Method to set the Gradle version when initalizing the wrapper</summary>
<version major="2" minor="34"/>
<date day="14" month="8" year="2023"/>
<author login="neilcsmith"/>
<compatibility semantic="compatible" addition="yes"/>
<description>
<p>
Added additional <a href="@TOP@/org/netbeans/modules/gradle/spi/newproject/TemplateOperation.html#addWrapperInit-java.io.File-java.lang.String-">addWrapperInit</a>
method allowing to request a specific version or version label when initializing the Gradle wrapper.
</p>
</description>
<class package="org.netbeans.modules.gradle.spi.newproject" name="TemplateOperation"/>
</change>
<change id="java-runtime-manager">
<api name="general"/>
<summary>Adding JavaRuntimeManager abstracting the Gradle Runtime from Java Platform</summary>
Expand Down
2 changes: 1 addition & 1 deletion extide/gradle/src/org/netbeans/modules/gradle/GradleJavaCompatProblemsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public void removePropertyChangeListener(PropertyChangeListener listener) {
"# {1} - Supported Java Version",
"# {2} - Required Gradle Version",
"# {3} - Forced Gradle Version",
"TXT_JavaVersionMismatch=<html>The Java version: {0}, that is seletced for the project "
"TXT_JavaVersionMismatch=<html>The Java version: {0}, that is selected for the project "
+ "is not supported by Gradle {2}."
+ "The IDE will attempt to use Gradle {3} to gather the project information.<p>"
+ "Possible solutions:"
Expand Down
35 changes: 32 additions & 3 deletions extide/gradle/src/org/netbeans/modules/gradle/spi/newproject/TemplateOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,29 @@ public void addConfigureProject(File projectDir, ProjectConfigurator configurato
steps.add(new ConfigureProjectStep(projectDir, configurator));
}

/**
* Initialize the Gradle wrapper in the target project. Equivalent to
* executing <code>gradle wrapper</code>.
*
* @param target project directory
*/
public void addWrapperInit(File target) {
steps.add(new InitGradleWrapper(target));
steps.add(new InitGradleWrapper(target, null));
}

/**
* Initialize the Gradle wrapper in the target project with the requested
* version of Gradle. Equivalent to executing
* <code>gradle wrapper --gradle-version $version</code>. The version may be
* the specific Gradle version required, or one of the labels supported by
* the wrapper task, eg. <code>latest</code>.
*
* @param target project directory
* @param version Gradle version or version label
* @since 2.34
*/
public void addWrapperInit(File target, String version) {
steps.add(new InitGradleWrapper(target, version));
}

/** * Begin creation of new project using Gradle's
Expand Down Expand Up @@ -443,9 +464,11 @@ public Set<FileObject> execute() {
private static final class InitGradleWrapper extends BaseOperationStep {

final File projectDir;
final String version;

public InitGradleWrapper(File projectDir) {
public InitGradleWrapper(File projectDir, String version) {
this.projectDir = projectDir;
this.version = version;
}

@Override
Expand All @@ -458,7 +481,13 @@ public String getMessage() {
public Set<FileObject> execute() {
GradleConnector gconn = GradleConnector.newConnector();
try (ProjectConnection pconn = gconn.forProjectDirectory(projectDir).connect()) {
pconn.newBuild().withArguments("--offline").forTasks("wrapper").run(); //NOI18N
List<String> args = new ArrayList<>();
args.add("wrapper"); //NOI18N
if (version != null) {
args.add("--gradle-version"); //NOI18N
args.add(version);
}
pconn.newBuild().withArguments("--offline").forTasks(args.toArray(new String[0])).run(); //NOI18N
} catch (GradleConnectionException | IllegalStateException ex) {
// Well for some reason we were not able to load Gradle.
// Ignoring that for now
Expand Down
5 changes: 4 additions & 1 deletion ....java/src/org/netbeans/modules/gradle/java/newproject/SimpleApplicationProjectWizard.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ static void collectOperationsForType(Map<String, Object> params, TemplateOperati

Boolean initWrapper = (Boolean) params.get(PROP_INIT_WRAPPER);
if (initWrapper == null || initWrapper) {
ops.addWrapperInit(root);
// @TODO allow configuration of wrapper version
ops.addWrapperInit(root, "latest"); // NOI18N
} else {
// @TODO delete wrapper added by init?
}
}

Expand Down