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

[FEATURE REQ] Make spring managed external dependencies' version more clear #27427

Closed
4 tasks
chenrujun opened this issue Mar 3, 2022 · 4 comments
Closed
4 tasks
Labels
azure-spring All azure-spring related issues Client This issue points to a problem in the data-plane of the library. feature-request This issue requires a new behavior in the product in order be resolved.
Milestone

Comments

@chenrujun
Copy link

chenrujun commented Mar 3, 2022

Context

Now all external dependencies' versions are stored in https://github.com/Azure/azure-sdk-for-java/blob/spring-cloud-azure_4.0.0/eng/versioning/external_dependencies.txt

Problem

Since spring-boot-dependencies and spring-cloud-dependencies may not release at the same time.

  1. spring-boot-dependencies release tags: https://github.com/spring-projects/spring-boot/tags
  2. spring-cloud-dependencies release tags: https://github.com/spring-cloud/spring-cloud-release/tags

And now all the versions managed by the 2 boms are stored in a file named "spring-boot_xxx_managed_external_dependencies". So if we only update spring-cloud-dependencies, it will override the last version and we can't keep track of them.

For example: when spring-boot-dependencies:2.6.4 released, and spring-cloud-dependencies:v2021.0.0 released, all managed versions are recorded in spring_boot_2.6.4_managed_external_dependencies.txt. After spring-cloud-dependencies:v2021.0.1 released, these versions are still recorded in the file, then the file will not have single source of truth. We should not change these files' content after they are created.

Solution

  • Update the logic in get_spring_boot_managed_external_dependencies.py: Put output file(spring-boot_xxx_managed_external_dependencies.txt) into a new folder: sdk/spring/scripts/spring-boot-xxx-and-spring-cloud-yyy.
  • Update the logic in get_spring_boot_managed_external_dependencies.py: Split spring-boot_xxx_managed_external_dependencies.txt into 2 files:
    • spring-boot-dependencies-managed-versions.txt.
    • spring-cloud-dependencies-managed-versions.txt.
  • Rename get_spring_boot_managed_external_dependencies.py to get_spring_boot_and_spring_cloud_managed_external_dependencies.py
  • Update the logic in get_spring_boot_and_spring_cloud_managed_external_dependencies.py: Output a new file named version conflicts.txt, which contains the versions that different in spring-boot-dependencies-managed-versions.txt and spring-cloud-dependencies-managed-versions.txt. This file have format like this:

group-id:artifact-id;spring-boot-dependencies-managed-version;spring-boot-dependencies-managed-version

The ci job should use the new file to check version compatibility. Here is link to related logic: https://github.com/Azure/azure-sdk-for-java/blob/spring-cloud-azure-dependencies_4.0.0-beta.3/sdk/spring/ci.yml#L345-L346

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Mar 3, 2022
@chenrujun chenrujun self-assigned this Mar 3, 2022
@chenrujun chenrujun added the azure-spring All azure-spring related issues label Mar 3, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Mar 3, 2022
@chenrujun chenrujun added Client This issue points to a problem in the data-plane of the library. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Mar 3, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Mar 3, 2022
@chenrujun chenrujun moved this to Todo in Spring Cloud Azure Mar 3, 2022
@chenrujun chenrujun modified the milestones: [2022] April, Backlog, [2022] May Mar 3, 2022
@chenrujun chenrujun assigned Netyyyy and unassigned chenrujun Mar 25, 2022
@chenrujun chenrujun modified the milestones: Backlog, [2022] May Mar 25, 2022
@chenrujun chenrujun changed the title [FEATURE REQ] Split spring-boot_xxx_managed_external_dependencies. [FEATURE REQ] Update get_spring_boot_managed_external_dependencies.py Mar 25, 2022
@stliu stliu added the feature-request This issue requires a new behavior in the product in order be resolved. label Apr 3, 2022
@stliu
Copy link
Member

stliu commented Apr 3, 2022

is this still valid?

and some suggestion:

  1. clearly describe the problem to be solved instead of prescribing a solution
  2. what the goal of this issue?

@stliu stliu modified the milestones: [2022] May, Backlog Apr 3, 2022
@chenrujun chenrujun changed the title [FEATURE REQ] Update get_spring_boot_managed_external_dependencies.py [FEATURE REQ] Make spring managed external dependencies' version more clear Apr 6, 2022
@chenrujun
Copy link
Author

@stliu

This is still valid.
I updated the Issue title and description. Thank you.

@Netyyyy Netyyyy modified the milestones: Backlog, [2022] June May 24, 2022
@Netyyyy
Copy link
Member

Netyyyy commented May 24, 2022

This will be a feature part in Azure/spring-cloud-azure-tools#2

@hui1110 hui1110 modified the milestones: [2022] June, [2022] July Jun 6, 2022
@Netyyyy Netyyyy modified the milestones: 2022-07, 2022-08 Jul 4, 2022
@Netyyyy Netyyyy modified the milestones: 2022-08, 2022-09 Aug 9, 2022
@moarychan moarychan modified the milestones: 2022-09, Backlog Aug 9, 2022
@Netyyyy Netyyyy removed their assignment Dec 9, 2022
Copy link

Hi @chenrujun, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 13, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Spring Cloud Azure Mar 13, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
azure-spring All azure-spring related issues Client This issue points to a problem in the data-plane of the library. feature-request This issue requires a new behavior in the product in order be resolved.
Projects
Archived in project
Development

No branches or pull requests

5 participants