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.

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

includeBuild in PluginManagementSpec deincubated in Gradle 8, docs still say it's incubating #24129

Closed
3flex opened this issue Mar 2, 2023 · 2 comments · Fixed by #24135
Closed
Assignees
Labels
a:documentation Documentation content in:composite-builds including BuildIdentifier
Milestone

Comments

@3flex
Copy link
Contributor

3flex commented Mar 2, 2023

Expected Behavior

Docs align to code/behaviour.

Current Behavior

includeBuild in org.gradle.plugin.management.PluginManagementSpec was deincubated in #22391, however composite build docs say:

Including plugin builds via the plugin management block is an incubating feature. You may also use the stable includeBuild mechanism outside pluginManagement to include plugin builds. However, this does not support all use cases and including plugin builds like that will be deprecated once the new mechanism is stable.

The promotion to stable also wasn't mentioned in the Gradle 8 release notes (I expected to see it under "Promoted features in the Settings API" in https://docs.gradle.org/8.0/release-notes.html#promoted-features)

Context

  • Docs aligning to code would have reduced my confusion when seeing this was deincubated in the IDE.
  • It would be good to know if "this does not support all use cases" is still true. I would think if it's a superior but otherwise drop-in replacement for using includeBuild outside pluginManagement that this change would be promoted somewhere in the release notes along with some explanation of why the new method is better than the old.
  • org.gradle.api.initialization#includeBuild also hasn't been deprecated now that the new mechanism is stable as the docs suggested would happen.

Steps to Reproduce

N/A

Your Environment

N/A

@eskatos eskatos added in:composite-builds including BuildIdentifier a:documentation Documentation content and removed a:bug to-triage labels Mar 3, 2023
@eskatos
Copy link
Member

eskatos commented Mar 3, 2023

Thank you for your interest in Gradle!

This is a valid documentation issue which we will address.

@ljacomet ljacomet added this to the 8.0.2 milestone Mar 3, 2023
@ljacomet
Copy link
Member

ljacomet commented Mar 3, 2023

Documentation will be updated in upcoming Gradle 8.0.2 release.

However for:

  • org.gradle.api.initialization#includeBuild also hasn't been deprecated now that the new mechanism is stable as the docs suggested would happen.

This is not deprecated at this stage, and the only thing that would be deprecated is including build that provide build logic. It remains the preferred way for including builds that do not provide build logic.

ljacomet added a commit that referenced this issue Mar 3, 2023
* settings.pluginManagement.includeBuild is no longer incubating
* Clarify limits of using settings.includeBuild for build logic

Fixes #24129
@ljacomet ljacomet linked a pull request Mar 3, 2023 that will close this issue
bot-gradle added a commit that referenced this issue Mar 3, 2023
* settings.pluginManagement.includeBuild is no longer incubating
* Clarify limits of using settings.includeBuild for build logic

Fixes #24129

Co-authored-by: Louis Jacomet <louis@gradle.com>
@ljacomet ljacomet closed this as completed Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Documentation content in:composite-builds including BuildIdentifier
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants