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

Add actionable information to dependency locking error messages #25756

Closed
aSemy opened this issue Jul 13, 2023 · 1 comment · Fixed by #25993
Closed

Add actionable information to dependency locking error messages #25756

aSemy opened this issue Jul 13, 2023 · 1 comment · Fixed by #25993
Assignees
Milestone

Comments

@aSemy
Copy link
Contributor

aSemy commented Jul 13, 2023

Issue type

Missing information

Problem description

Add actionable information to dependency locking failures

Context (optional)

I'm a regular developer who has picked up an existing Gradle project that has enabled dependency locking. When I try and build my project, I get an error:

Locking strict mode: Configuration ':app:kotlinCompilerPluginClasspathJvmMain' is locked but does not have lock state

I am not sure what to do. I understand there is a problem, but it's not clear how to resolve it.

Currently I have to Google around, but there's no obvious matches for this error. The error message isn't in the Gradle docs page, so there's no clear section I can jump to.

If I'm lucky I might find a StackOverflow answer that has a solution, or the Gradle docs (although these docs are not clear #25293).

It would be a much better user experience if the error message told me what my options are, and how to fix it.

For example:

Locking strict mode: Configuration ':app:kotlinCompilerPluginClasspathJvmMain' is locked but does not have lock state. 

To create the lock state, run `./gradlew <task name>`

This would make Gradle more helpful, and reduce the amount of work required to perform a simple update task.

It would also help new developers learn Grade.

Page with the problem

n/a

@aSemy aSemy added a:documentation Documentation content to-triage labels Jul 13, 2023
@ov7a ov7a added a:bug in:dependency-locking in:problems problems api and removed a:documentation Documentation content to-triage labels Jul 14, 2023
@ov7a
Copy link
Member

ov7a commented Jul 14, 2023

Thank you for providing a detailed description.

The issue is in the backlog of the relevant team, but this area of Gradle is currently not a focus one, so it might take a while before a fix is made.


You're right, the error message should be improved.

Some information about the error can be found here

@ljacomet ljacomet self-assigned this Aug 2, 2023
@ljacomet ljacomet added this to the 8.4 RC1 milestone Aug 2, 2023
ljacomet added a commit that referenced this issue Nov 24, 2023
With this support, advice and documentation link properly appear in the
Try section on the console output.

This is an improvement over #25993 which already provided a
documentation
 link.

Issue #25756
ljacomet added a commit that referenced this issue Nov 30, 2023
With this support, advice and documentation link properly appear in the
Try section on the console output.

This is an improvement over #25993 which already provided a
documentation
 link.

Issue #25756
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants