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

Gradle Conflict Resolution documentation potentially has wrong logic for base version and qualifier parsing #25798

Closed
tacascer opened this issue Jul 17, 2023 · 5 comments · Fixed by #25845
Assignees
Labels
a:documentation Documentation content good first issue Good for newcomers in:dependency-declarations variant notation attributes capability substitution
Milestone

Comments

@tacascer
Copy link

Issue type

Wrong or misleading information

Problem description

Hi there!

I noticed that the table depicting the logic for parsing a Base Version and a Qualifier from an Original Version had a potentially wrong parsing.

In the example of b1-2-3.3, the base version is b and the qualifier is 2-3.3. It seems that the 1 is simply dropped.

According to my understanding, should the qualifier be 1-2-3.3 instead?

Thank you for your help and attention!

Context (optional)

No response

Page with the problem

https://docs.gradle.org/current/userguide/dependency_resolution.html#sec:base-version-comparison

@tacascer tacascer added a:documentation Documentation content to-triage labels Jul 17, 2023
@ov7a
Copy link
Member

ov7a commented Jul 19, 2023

Thank you for your interest in Gradle!

This is a valid documentation issue that we will address.


This issue is a good choice for first-time contributors to Gradle, it is actionable and ready for contribution.

See CONTRIBUTING.md for more information.

@ov7a ov7a added in:dependency-declarations variant notation attributes capability substitution good first issue Good for newcomers and removed to-triage labels Jul 19, 2023
@pratik2315
Copy link
Contributor

Hey there! May I work on this issue if it's still available?

@ov7a
Copy link
Member

ov7a commented Jul 20, 2023

@pratik2315 Yes, thank you!

@pratik2315
Copy link
Contributor

Thanks, @ov7a !
I have created a PR, since it's my first time making a contribution here, would you please check if everything is okay with it and suggest changes if possible? Thanks again :)

@ov7a
Copy link
Member

ov7a commented Jul 21, 2023

@pratik2315 Everything is ok, I've scheduled your pr to merge. Congrats on your first contribution! It's a small change, but it's honest work:)

bot-gradle added a commit that referenced this issue Jul 21, 2023
Fixes #25798

### Context
Changed the qualifier version to `1-2-3.3` instead of `2-3.3` [here ](https://docs.gradle.org/current/userguide/dependency_resolution.html#sec:base-version-comparison)in the docs.

### Contributor Checklist
- [x] [Review Contribution Guidelines](https://github.com/gradle/gradle/blob/master/CONTRIBUTING.md)
- [x] Make sure that all commits are [signed off](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) to indicate that you agree to the terms of [Developer Certificate of Origin](https://developercertificate.org/).
- [x] Make sure all contributed code can be distributed under the terms of the [Apache License 2.0](https://github.com/gradle/gradle/blob/master/LICENSE), e.g. the code was written by yourself or the original code is licensed under [a license compatible to Apache License 2.0](https://apache.org/legal/resolved.html).
- [x] Check ["Allow edit from maintainers" option](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) in pull request so that additional changes can be pushed by Gradle team
- [x] Provide integration tests (under `<subproject>/src/integTest`) to verify changes from a user perspective
- [x] Provide unit tests (under `<subproject>/src/test`) to verify logic
- [x] Update User Guide, DSL Reference, and Javadoc for public-facing changes
- [x] Ensure that tests pass sanity check: `./gradlew sanityCheck`
- [x] Ensure that tests pass locally: `./gradlew <changed-subproject>:quickTest`

Co-authored-by: Pratik Haldankar <pratikhaldankar360@gmail.com>
@bot-gradle bot-gradle added this to the 8.4 RC1 milestone Jul 21, 2023
@ov7a ov7a removed the to-triage label Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Documentation content good first issue Good for newcomers in:dependency-declarations variant notation attributes capability substitution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants