Skip to content

Document how to use Devtools without an IDE #24271

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

Closed
wants to merge 1 commit into from

Conversation

CubeOfCheese
Copy link
Contributor

Updates docs in order to avoid confusion for people who aren't using an IDE. The following NOTE paragraph alone made it seem like the build plugins should just work in the same way as devtools via an IDE.

This somewhat helps address the problem brought up in issue #5136

I discovered that this step was necessary only after hours of searching and testing when I noticed it here: #3315 (comment)

In order to avoid confusion for people who aren't using an IDE. The following NOTE paragraph alone makes it seem like the build plugins should just work in the same way as devtools via an IDE
@pivotal-issuemaster
Copy link

@CubeOfCheese Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 29, 2020
@pivotal-issuemaster
Copy link

@CubeOfCheese Thank you for signing the Contributor License Agreement!

@snicoll
Copy link
Member

snicoll commented Nov 30, 2020

The following NOTE paragraph alone made it seem like the build plugins should just work in the same way as devtools via an IDE.

I am not sure I understand what you mean. The purpose of the note is to warn you that the classpath should be updated for devtools to show the change. A build system is not going to update the classpath for you unless instructed to do so.

That being said, thank you for the PR, I think the additional note is a good idea and provide additional context for those who aren't using an IDE.

@snicoll
Copy link
Member

snicoll commented Nov 30, 2020

As part of this change, I'd like we explore the opportunity to reference the trick Andy shared previously with Gradle, see #5136 (comment)

@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Nov 30, 2020
@snicoll snicoll added this to the 2.2.x milestone Nov 30, 2020
@snicoll snicoll changed the title Adds mention of build plugins Document how to use Devtools without an IDE Nov 30, 2020
@CubeOfCheese
Copy link
Contributor Author

The following NOTE paragraph alone made it seem like the build plugins should just work in the same way as devtools via an IDE.

I am not sure I understand what you mean. The purpose of the note is to warn you that the classpath should be updated for devtools to show the change. A build system is not going to update the classpath for you unless instructed to do so.

That being said, thank you for the PR, I think the additional note is a good idea and provide additional context for those who aren't using an IDE.

When I said following Note, I was referring to this paragraph:

NOTE: As long as forking is enabled, you can also start your application by using the supported build plugins (Maven and Gradle), since DevTools needs an isolated application classloader to operate properly.
By default, the Gradle and Maven plugins fork the application process.

This paragraph implied to me that using a build plugin with devtools should work just as it does with an IDE (recompiling on save) as long as forking is enabled. Maybe that was just my own poor interpretation.

@snicoll
Copy link
Member

snicoll commented Nov 30, 2020

Thanks for the follow-up. I had missed that and I agree this particular note is confusing. I'll review it as part of polishing your contribution.

philwebb pushed a commit that referenced this pull request Dec 9, 2020
Update the documentation to help avoid confusion for people who aren't
using an IDE.

See gh-24271
philwebb added a commit that referenced this pull request Dec 9, 2020
@philwebb philwebb closed this in 9dfd766 Dec 9, 2020
@philwebb philwebb modified the milestones: 2.2.x, 2.2.12 Dec 9, 2020
philwebb added a commit that referenced this pull request Dec 9, 2020
@philwebb
Copy link
Member

philwebb commented Dec 9, 2020

Thanks very much for the PR @CubeOfCheese

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants