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

[chore] add githubgen to enhance codeowners and issue templates #11756

Merged

Conversation

mowies
Copy link
Member

@mowies mowies commented Nov 26, 2024

This PR

  • adds the githubgen tool as a dependency in internal/tools
  • uses githubgen to generate codeowners and issue template files
  • updates lots of metadata files by
    • taking the existing codeowners file and feeding the info from there back into the component metadata.yaml files or creating new metadata.yaml files where none existed yet
  • adds distributions.yaml as a basis the mostly already existing distributions: keys in metadata.yaml files (needed for githubgen to work correctly)
  • adds relevant make commands to make the githubgen tool usage mostly transparent to users

This change is a prerequisite to be able to ping codeowners reliably with automated tooling as a next step.

Part of #11562

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.41%. Comparing base (7d603aa) to head (7897671).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11756   +/-   ##
=======================================
  Coverage   91.41%   91.41%           
=======================================
  Files         467      467           
  Lines       25583    25583           
=======================================
  Hits        23387    23387           
  Misses       1778     1778           
  Partials      418      418           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mowies mowies changed the title [chore] enhance issue templates [chore] add githubgen tool to enhance issue templates Nov 27, 2024
@mowies mowies force-pushed the enhance-issue-template branch 2 times, most recently from eeb45e6 to e969405 Compare December 4, 2024 10:39
.github/CODEOWNERS Outdated Show resolved Hide resolved
@mowies mowies marked this pull request as ready for review December 4, 2024 11:47
@evan-bradley
Copy link
Contributor

Follow ups: move the githubgen tool to a central place so that we don't need to duplicate it in contrib and core repos

https://github.com/open-telemetry/opentelemetry-go-build-tools/ is probably the right place. Could we just pull the module from contrib (like we do with chloggen) and if we move it update the reference? Referencing it in the internal/tools package should be fairly straightforward.

@mowies
Copy link
Member Author

mowies commented Dec 5, 2024

@evan-bradley that would be possible but I made a few minor changes to the tool to make it work with this repo (e.g. changing the file templates), so that would need to be parameterized in the original tool first to be able to do that. I wanted to do exactly that in a follow up issue afterwards to be able to clearly see what we need to change in the tool to make it general enough to serve both or even more repos in the future.

@mowies
Copy link
Member Author

mowies commented Dec 5, 2024

I filed open-telemetry/opentelemetry-collector-contrib#36691 to take care of moving githubgen to the build-tools repo

@atoulme
Copy link
Contributor

atoulme commented Dec 6, 2024

yes, go-build-tools seems like a better home.

@mx-psi
Copy link
Member

mx-psi commented Dec 11, 2024

@mowies Do you think moving to go-build-tools as a first step is doable? I think it's probably less of a hassle than copying the code here

@mowies
Copy link
Member Author

mowies commented Dec 11, 2024

I'm already working on it :)
Draft PR is open, but that will take a little bit cus the tool has 0 unit tests

Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@github-actions github-actions bot added the Stale label Dec 27, 2024
@mowies
Copy link
Member Author

mowies commented Dec 27, 2024

this is still active

@github-actions github-actions bot removed the Stale label Dec 28, 2024
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
@mowies mowies changed the title [chore] add githubgen tool to enhance issue templates [chore] add githubgen tool to enhance codeowners and issue templates Jan 27, 2025
@mowies mowies changed the title [chore] add githubgen tool to enhance codeowners and issue templates [chore] add githubgen to enhance codeowners and issue templates Jan 27, 2025
@mowies mowies marked this pull request as ready for review January 27, 2025 12:39
@mowies mowies requested review from atoulme and mx-psi January 27, 2025 12:41
# Conflicts:
#	internal/tools/go.mod
#	internal/tools/go.sum
- cmd/mdatagen/internal/samplescraper
- confmap
- connector/forward
- connector/x
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be connector/xconnector, right?

Suggested change
- connector/x
- connector/xconnector

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is kind of a limitation of the githubgen tool currently. I didn't get around to fix it yet, but I think for now it should be fine. I don't think those components are selected often if at all in the issue templates.

@mx-psi
Copy link
Member

mx-psi commented Jan 31, 2025

I will merge this in one week if there are no further comments cc @open-telemetry/collector-approvers

@mx-psi mx-psi added this pull request to the merge queue Feb 6, 2025
Merged via the queue into open-telemetry:main with commit 43087bd Feb 6, 2025
54 checks passed
@mowies mowies deleted the enhance-issue-template branch February 6, 2025 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants