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

[DOC] Upgrade for each dependency is hard to maintain #2678

Open
marcalff opened this issue May 23, 2024 · 8 comments
Open

[DOC] Upgrade for each dependency is hard to maintain #2678

marcalff opened this issue May 23, 2024 · 8 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Good for taking. Extra help will be provided by maintainers triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@marcalff
Copy link
Member

marcalff commented May 23, 2024

In light of #2676 and #2677, it turns out upgrading each dependency is not trivial, because versions numbers for each dependencies are spread in multiple files in the source code, some of them long forgotten and easy to overlook.

In this case, opentelemetry-proto was updated to 1.3.1 in a few places, but left as 1.1.0 in others.

Provide maintainers documentation that lists exhaustively, for each dependency:

  • where the dependency comes from
  • what are the minimal version requirements
  • which files needs to be updated
  • which special build or tests need to be considered
  • anything else relevant for maintainers
@marcalff marcalff added the bug Something isn't working label May 23, 2024
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 23, 2024
@marcalff marcalff self-assigned this May 29, 2024
@marcalff marcalff added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 29, 2024
@marcalff marcalff added the documentation Improvements or additions to documentation label Jun 25, 2024
Copy link

This issue was marked as stale due to lack of activity.

@github-actions github-actions bot added the Stale label Aug 25, 2024
@Annosha
Copy link

Annosha commented Oct 17, 2024

Hi, @marcalff I would like to work on this issue as a beginner? Is it still open for changes?

@github-actions github-actions bot removed the Stale label Oct 19, 2024
@marcalff marcalff removed their assignment Nov 7, 2024
@marcalff
Copy link
Member Author

marcalff commented Nov 7, 2024

Hi, @marcalff I would like to work on this issue as a beginner? Is it still open for changes?

Sorry I missed this message.

Yes, any contributions are welcome.

The goal is up expand the docs/maintaining-dependencies.md file.

@marcalff marcalff added help wanted Good for taking. Extra help will be provided by maintainers good first issue Good for newcomers labels Nov 7, 2024
Copy link

github-actions bot commented Nov 7, 2024

This issue is available for anyone to work on. Make sure to reference this issue in your pull request.
✨ Thank you for your contribution! ✨

@zurex
Copy link
Contributor

zurex commented Dec 4, 2024

Hi @marcalff, could i pick this since @Annosha no activity for more than a month. I plan to raise separate pull requests for each dependency and check in new md in doc folder. Does it work for you?

@zurex
Copy link
Contributor

zurex commented Dec 5, 2024

There is already a maintain document, and the missing content will be added based on this document.

@zurex
Copy link
Contributor

zurex commented Dec 5, 2024

Currently, the steps to update a dependency in maintaining-dependencies.md have a lot of similar and repeated parts. It would be better to separate them into a common section to follow.
I will add how to update git submodule and how to update bazel dependency as a new section. In the same time i will remove this part from existing dependencies upgrade doc and add a link to the new section for follow.

@zurex
Copy link
Contributor

zurex commented Dec 15, 2024

Check in new dependencies:

  • nlohmann-json
  • abseil

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Good for taking. Extra help will be provided by maintainers triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants