feat: add githubgen tool #639

mowies · 2024-12-10T12:14:43Z

Fixes open-telemetry/opentelemetry-collector-contrib#36691

codecov · 2024-12-10T12:16:41Z

Codecov Report

Attention: Patch coverage is 12.04819% with 292 lines in your changes missing coverage. Please review.

Project coverage is 47.13%. Comparing base (4f5cd22) to head (7d87860).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
githubgen/codeowners.go	0.00%	134 Missing ⚠️
githubgen/main.go	21.15%	79 Missing and 3 partials ⚠️
githubgen/issuetemplates.go	0.00%	41 Missing ⚠️
githubgen/distributions.go	0.00%	33 Missing ⚠️
githubgen/datatype/fake/mock_generator.go	90.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #639      +/-   ##
==========================================
- Coverage   51.17%   47.13%   -4.05%     
==========================================
  Files          51       56       +5     
  Lines        2882     3214     +332     
==========================================
+ Hits         1475     1515      +40     
- Misses       1260     1548     +288     
- Partials      147      151       +4

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

atoulme · 2024-12-11T17:04:22Z

githubgen/codeowners.go

+const allowlistHeader = `# Code generated by githubgen. DO NOT EDIT.
+#####################################################
+#
+# List of components in OpenTelemetry Collector Contrib


hardcoded to contrib

atoulme · 2024-12-11T17:04:40Z

githubgen/codeowners.go

+const codeownersHeader = `# Code generated by githubgen. DO NOT EDIT.
+#####################################################
+#
+# List of codeowners for OpenTelemetry Collector Contrib


hardcoded, we might need to make that configurable.

atoulme · 2024-12-11T17:04:49Z

githubgen/codeowners.go

+# https://help.github.com/en/articles/about-code-owners
+#
+
+* @open-telemetry/collector-contrib-approvers


atoulme · 2024-12-11T17:04:54Z

githubgen/codeowners.go

+const distributionCodeownersHeader = `
+#####################################################
+#
+# List of distribution maintainers for OpenTelemetry Collector Contrib


also hardcoded

atoulme · 2024-12-11T17:05:08Z

githubgen/codeowners.go

+		for stability := range m.Status.Stability {
+			if stability == unmaintainedStatus {
+				unmaintainedList += key + "/\n"
+				unmaintainedCodeowners += fmt.Sprintf("%s/%s @open-telemetry/collector-contrib-approvers \n", key, strings.Repeat(" ", data.maxLength-len(key)))


hardcoded as well here.

atoulme · 2024-12-11T17:05:15Z

githubgen/codeowners.go

+				owners += " "
+				owners += "@" + owner
+			}
+			codeowners += fmt.Sprintf("%s/%s @open-telemetry/collector-contrib-approvers%s\n", key, strings.Repeat(" ", data.maxLength-len(key)), owners)


hardcoded as well here

atoulme

LGTM as a code introduction, we can add tests right now to check doc generation and make sure to add more config to override the default group assignment and project name.

mowies · 2024-12-12T07:42:53Z

@atoulme thanks for the review. I will add at least a sanity check unit test in this PR which will already need some slight refactoring and then do any further changes in follow-ups.

Signed-off-by: Moritz Wiesinger <[email protected]>

Signed-off-by: odubajDT <[email protected]>

Signed-off-by: Moritz Wiesinger <[email protected]>

mx-psi · 2024-12-17T14:00:47Z

@pjanotti If you have the time, could you take a quick look at the failing CI check and try to help us figure out why it is failing?

pjanotti · 2024-12-17T19:48:30Z

@mowies the issue can be solved by creating a moq.exe at the .tools directory. When in the make shell env the bash.exe takes care of that, but, I suspect that go generate (as it should) uses the Windows Shell API that requires the .exe extension. A quick (and a bit dirt 😸) workaround will be to cp .\.tools\moq .\.tools\moq.exe before calling make build ... (ducking for cover...)

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies · 2024-12-18T08:10:20Z

@pjanotti wow thanks for the help, I don't think I would have found that by myself at all 😅
seems like everything works now 🙌🏼

dmathieu · 2024-12-18T08:34:40Z

githubgen/issuetemplates.go

+	switch path[0] {
+	case "receiver", "exporter", "extension", "processor", "connector":
+		path[1] = strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(path[1], "internal"), "extension"), "exporter"), "connector"), "processor"), "receiver")
+		path[len(path)-1] = strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(strings.TrimSuffix(path[len(path)-1], "internal"), "extension"), "exporter"), "connector"), "processor"), "receiver")


This looks like it shouldn't be hardcoded, but configurable per repository?

mowies · 2024-12-18T08:41:52Z

@atoulme @dmathieu thanks for the reviews! I will implement the feedback along with more unit tests in a follow up PR so that all that gets easier to review.

…low ups are implemented Signed-off-by: Moritz Wiesinger <[email protected]>

Signed-off-by: Moritz Wiesinger <[email protected]>

mx-psi

Approving based on the comment above

atoulme reviewed Dec 11, 2024

View reviewed changes

atoulme approved these changes Dec 11, 2024

View reviewed changes

mowies mentioned this pull request Dec 12, 2024

[chore] add githubgen tool to enhance issue templates open-telemetry/opentelemetry-collector#11756

Open

mowies and others added 16 commits December 12, 2024 10:25

feat: add githubgen tool

5ec8630

Signed-off-by: Moritz Wiesinger <[email protected]>

add changelog entry

b90fc12

Signed-off-by: Moritz Wiesinger <[email protected]>

add githubgen to versions file

ddf8592

Signed-off-by: Moritz Wiesinger <[email protected]>

adapt module name, adapt makefile

5b0722b

Signed-off-by: Moritz Wiesinger <[email protected]>

make linter happy

fad052c

Signed-off-by: Moritz Wiesinger <[email protected]>

make dependabot-generate

7c4ee3e

Signed-off-by: Moritz Wiesinger <[email protected]>

make linter happier

275b19c

Signed-off-by: Moritz Wiesinger <[email protected]>

more linting things

644637e

Signed-off-by: Moritz Wiesinger <[email protected]>

adjust readme, go version, flag default value

026bd29

Signed-off-by: Moritz Wiesinger <[email protected]>

refactoring

57f140b

Signed-off-by: Moritz Wiesinger <[email protected]>

make linter happy

8c19e01

Signed-off-by: Moritz Wiesinger <[email protected]>

remove githubgen from makefile

a275020

Signed-off-by: Moritz Wiesinger <[email protected]>

refactoring

9f50acd

Signed-off-by: Moritz Wiesinger <[email protected]>

WIP

e10eb15

Signed-off-by: Moritz Wiesinger <[email protected]>

fixed import cycles

2ebadce

Signed-off-by: odubajDT <[email protected]>

move reading of distros to main func

af6b14a

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies force-pushed the add-githubgen branch from 89b4763 to af6b14a Compare December 12, 2024 09:25

mowies added 3 commits December 12, 2024 10:29

fix license headers

b15b8f7

Signed-off-by: Moritz Wiesinger <[email protected]>

make tidy

b9125f2

Signed-off-by: Moritz Wiesinger <[email protected]>

fix module changes

bf25a42

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies added 13 commits December 16, 2024 10:23

more debugging

513d1f9

Signed-off-by: Moritz Wiesinger <[email protected]>

more debugging

25e07b6

Signed-off-by: Moritz Wiesinger <[email protected]>

try switching path delimiter

f8c25da

Signed-off-by: Moritz Wiesinger <[email protected]>

try with lesss quotes

57259d7

Signed-off-by: Moritz Wiesinger <[email protected]>

try with lesss quotes

66c4108

Signed-off-by: Moritz Wiesinger <[email protected]>

again

b46f4bb

Signed-off-by: Moritz Wiesinger <[email protected]>

try again

bb4b012

Signed-off-by: Moritz Wiesinger <[email protected]>

try exporting before loop

4088866

Signed-off-by: Moritz Wiesinger <[email protected]>

try again

70f872a

Signed-off-by: Moritz Wiesinger <[email protected]>

works but sucks...

c3ba601

try ls ing the path

435f0d0

Signed-off-by: Moritz Wiesinger <[email protected]>

debugging

08f9cf7

Signed-off-by: Moritz Wiesinger <[email protected]>

try some more things

588c907

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies marked this pull request as draft December 16, 2024 10:33

try setting pipeline shell to bash

8b3e049

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies added 4 commits December 18, 2024 08:58

add exe file ending on windows

74f7d03

Signed-off-by: Moritz Wiesinger <[email protected]>

try with bash

17e72e7

Signed-off-by: Moritz Wiesinger <[email protected]>

debugging

280ba24

Signed-off-by: Moritz Wiesinger <[email protected]>

cleanup

4adfe5d

Signed-off-by: Moritz Wiesinger <[email protected]>

mowies marked this pull request as ready for review December 18, 2024 08:10

dmathieu reviewed Dec 18, 2024

View reviewed changes

mowies added 2 commits December 18, 2024 10:29

remove githubgen from versions file to unblock releases until all fol…

a5142fb

…low ups are implemented Signed-off-by: Moritz Wiesinger <[email protected]>

revert

7d87860

Signed-off-by: Moritz Wiesinger <[email protected]>

mx-psi approved these changes Dec 18, 2024

View reviewed changes

mx-psi merged commit fcfa1a6 into open-telemetry:main Dec 18, 2024
10 of 12 checks passed

mowies deleted the add-githubgen branch December 18, 2024 10:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add githubgen tool #639

feat: add githubgen tool #639

mowies commented Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

atoulme Dec 11, 2024

atoulme Dec 11, 2024

atoulme Dec 11, 2024

atoulme Dec 11, 2024

atoulme Dec 11, 2024

atoulme Dec 11, 2024

atoulme left a comment

mowies commented Dec 12, 2024

mx-psi commented Dec 17, 2024

pjanotti commented Dec 17, 2024 •

edited

Loading

mowies commented Dec 18, 2024

dmathieu Dec 18, 2024

mowies commented Dec 18, 2024

mx-psi left a comment

feat: add githubgen tool #639

feat: add githubgen tool #639

Conversation

mowies commented Dec 10, 2024 • edited Loading

codecov bot commented Dec 10, 2024 • edited Loading

Codecov Report

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme Dec 11, 2024

Choose a reason for hiding this comment

atoulme left a comment

Choose a reason for hiding this comment

mowies commented Dec 12, 2024

mx-psi commented Dec 17, 2024

pjanotti commented Dec 17, 2024 • edited Loading

mowies commented Dec 18, 2024

dmathieu Dec 18, 2024

Choose a reason for hiding this comment

mowies commented Dec 18, 2024

mx-psi left a comment

Choose a reason for hiding this comment

mowies commented Dec 10, 2024 •

edited

Loading

codecov bot commented Dec 10, 2024 •

edited

Loading

pjanotti commented Dec 17, 2024 •

edited

Loading