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 tool to enhance issue templates #11756

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

mowies
Copy link
Member

@mowies mowies commented Nov 26, 2024

This PR enhances some of the existing issue templates by changing them to be interactive forms, similar to collector-contrib. This is needed to be able to automate codeowner updates and to then be able to ping codeowners reliably with automated tooling.

Follow ups:

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

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.44%. Comparing base (5272797) to head (3b7fa2d).
Report is 96 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11756   +/-   ##
=======================================
  Coverage   91.44%   91.44%           
=======================================
  Files         446      446           
  Lines       23742    23742           
=======================================
  Hits        21712    21712           
  Misses       1654     1654           
  Partials      376      376           

☔ 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
@@ -15,7 +15,7 @@ status:
distributions: []
unsupported_platforms: [freebsd, illumos]
codeowners:
active: [some]
active: []
Copy link
Member Author

Choose a reason for hiding this comment

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

removed since some is an actual user and not affiliated or related to OTel

#

* @open-telemetry/collector-approvers

# List all maintainers individually so all of them are notified
.github/CODEOWNERS @codeboten @BogdanDrutu @dmitryax @mx-psi
docs/rfc @codeboten @BogdanDrutu @dmitryax @mx-psi

cmd/githubgen/ @open-telemetry/collector-approvers @atoulme
Copy link
Member Author

Choose a reason for hiding this comment

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

hope this fine since @atoulme is also maintainer for the tool in contrib :)

Copy link
Contributor

Choose a reason for hiding this comment

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

feel free to put your name here too.

@@ -0,0 +1,10 @@
type: rfcs
Copy link
Member Author

Choose a reason for hiding this comment

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

i added this for completeness sake and to make githubgen work correctly. owners list taken from current codeowners file

@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 <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
@mowies mowies force-pushed the enhance-issue-template branch from 3b7fa2d to ef99e30 Compare January 13, 2025 13:12
Signed-off-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
@mowies mowies marked this pull request as draft January 15, 2025 10:14
@atoulme
Copy link
Contributor

atoulme commented Jan 19, 2025

Looking good to me, how about getting it out of draft and fixing conflicts, and then we can get it in?

@mowies
Copy link
Member Author

mowies commented Jan 20, 2025

yes! but ideally, i'd like to merge and maybe also release open-telemetry/opentelemetry-go-build-tools#655 first

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.

4 participants