Skip to content

Fix javadoc for "resolvable" in JsonProjectDependencyRenderer#29544

Merged
bot-gradle merged 1 commit intogradle:masterfrom
candrews:patch-2
Jul 17, 2024
Merged

Fix javadoc for "resolvable" in JsonProjectDependencyRenderer#29544
bot-gradle merged 1 commit intogradle:masterfrom
candrews:patch-2

Conversation

@candrews
Copy link
Copy Markdown
Contributor

In the html dependency report's json, the "resolvable" field is not a boolean; it is of type RenderableDependency which is an enum of FAILED, RESOLVED, RESOLVED_CONSTRAINT, UNRESOLVED.

Context

The javadoc is wrong and that is never good :)

Contributor Checklist

  • Review Contribution Guidelines.
  • Make sure that all commits are signed off to indicate that you agree to the terms of Developer Certificate of Origin.
  • Make sure all contributed code can be distributed under the terms of the Apache License 2.0, e.g. the code was written by yourself or the original code is licensed under a license compatible to Apache License 2.0.
  • Check "Allow edit from maintainers" option in pull request so that additional changes can be pushed by Gradle team.
  • Provide integration tests (under <subproject>/src/integTest) to verify changes from a user perspective.
  • Provide unit tests (under <subproject>/src/test) to verify logic.
  • Update User Guide, DSL Reference, and Javadoc for public-facing changes.
  • Ensure that tests pass sanity check: ./gradlew sanityCheck.
  • Ensure that tests pass locally: ./gradlew <changed-subproject>:quickTest.

Reviewing cheatsheet

Before merging the PR, comments starting with

  • ❌ ❓must be fixed
  • 🤔 💅 should be fixed
  • 💭 may be fixed
  • 🎉 celebrate happy things

In the html dependency report's json, the "resolvable" field is not a boolean; it is of type RenderableDependency which is an enum of FAILED, RESOLVED, RESOLVED_CONSTRAINT, UNRESOLVED.

Signed-off-by: Craig Andrews <candrews@integralblue.com>
@candrews candrews requested a review from a team June 13, 2024 21:04
@bot-gradle bot-gradle added from:contributor PR by an external contributor to-triage labels Jun 13, 2024
@ljacomet ljacomet added in:reporting-tasks console reporting tasks infrastructure 👋 team-triage Issues that need to be triaged by a specific team and removed to-triage labels Jun 17, 2024
@ljacomet
Copy link
Copy Markdown
Member

Thank you for your contribution!

The relevant team for this area will confirm the changes.


Ideally, we should improve the report by replacing resolvable with something like resolveState. But that could be considered a breaking change.

Our recommendation is to either accept this PR as-is if we do not want to risk the breaking change but file an issue so that a later proper fix can be done, most likely around a major release.

@big-guy
Copy link
Copy Markdown
Member

big-guy commented Jul 17, 2024

@ljacomet This is entirely internal, so we could change it.

@big-guy
Copy link
Copy Markdown
Member

big-guy commented Jul 17, 2024

@bot-gradle merge

@bot-gradle bot-gradle added this pull request to the merge queue Jul 17, 2024
@bot-gradle bot-gradle added this to the 8.10 RC1 milestone Jul 17, 2024
@big-guy big-guy self-assigned this Jul 17, 2024
@big-guy big-guy removed the 👋 team-triage Issues that need to be triaged by a specific team label Jul 17, 2024
Merged via the queue into gradle:master with commit 6e3182b Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

from:contributor PR by an external contributor in:reporting-tasks console reporting tasks infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants