Skip to content

Commit 43087bd

Browse files
mowiesmowies
authored
[chore] add githubgen to enhance codeowners and issue templates (#11756)
### 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 --------- Signed-off-by: Moritz Wiesinger <[email protected]>
1 parent 7d603aa commit 43087bd

File tree

40 files changed

+569
-93
lines changed

40 files changed

+569
-93
lines changed

‎.github/ALLOWLIST

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Code generated by githubgen. DO NOT EDIT.
2+
#####################################################
3+
#
4+
# List of components
5+
# waiting on owners to be assigned
6+
#
7+
#####################################################
8+
#
9+
# Learn about CODEOWNERS file format:
10+
# https://help.github.com/en/articles/about-code-owners
11+
#
12+
13+
##
14+
# NOTE: New components MUST have one or more codeowners. Add codeowners to the component metadata.yaml and run make gengithub
15+
##
16+
17+
## COMMON & SHARED components
18+
internal/common
19+
20+
## DEPRECATED components
21+
22+
## UNMAINTAINED components

‎.github/CODEOWNERS

+64-28
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,73 @@
1+
# Code generated by githubgen. DO NOT EDIT.
12
#####################################################
23
#
3-
# List of approvers for OpenTelemetry Collector
4+
# List of codeowners
45
#
56
#####################################################
67
#
7-
# Learn about membership in OpenTelemetry community:
8-
# https://github.com/open-telemetry/community/blob/main/community-membership.md
9-
#
10-
#
11-
# Learn about CODEOWNERS file format:
12-
# https://help.github.com/en/articles/about-code-owners
8+
# Learn about CODEOWNERS file format:
9+
# https://help.github.com/en/articles/about-code-owners
1310
#
1411

1512
* @open-telemetry/collector-approvers
1613

17-
# List all maintainers individually so all of them are notified
18-
.github/CODEOWNERS @open-telemetry/collector-approvers @codeboten @BogdanDrutu @dmitryax @mx-psi
19-
docs/rfc @open-telemetry/collector-approvers @codeboten @BogdanDrutu @dmitryax @mx-psi
20-
21-
confmap/ @open-telemetry/collector-approvers @mx-psi @evan-bradley
22-
exporter/debugexporter @open-telemetry/collector-approvers @andrzej-stencel
23-
exporter/exporterhelper @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
24-
exporter/nopexporter @open-telemetry/collector-approvers @evan-bradley
25-
pdata/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
26-
receiver/nopreceiver @open-telemetry/collector-approvers @evan-bradley
27-
service/internal/graph @open-telemetry/collector-approvers @djaglowski
28-
extension/xextension @open-telemetry/collector-approvers @swiatekm
29-
30-
# Profiling-related modules
31-
pdata/pprofile @open-telemetry/collector-approvers @mx-psi @dmathieu
32-
consumer/xconsumer @open-telemetry/collector-approvers @mx-psi @dmathieu
33-
connector/xconnector @open-telemetry/collector-approvers @mx-psi @dmathieu
34-
exporter/exporterhelper/xexporterhelper @open-telemetry/collector-approvers @mx-psi @dmathieu
35-
exporter/xexporter @open-telemetry/collector-approvers @mx-psi @dmathieu
36-
processor/xprocessor @open-telemetry/collector-approvers @mx-psi @dmathieu
37-
receiver/xreceiver @open-telemetry/collector-approvers @mx-psi @dmathieu
14+
cmd/mdatagen/ @open-telemetry/collector-approvers @dmitryax
15+
cmd/mdatagen/internal/sampleprocessor/ @open-telemetry/collector-approvers
16+
cmd/mdatagen/internal/samplereceiver/ @open-telemetry/collector-approvers @dmitryax
17+
cmd/mdatagen/internal/samplescraper/ @open-telemetry/collector-approvers @dmitryax
18+
19+
confmap/ @open-telemetry/collector-approvers @mx-psi @evan-bradley
20+
21+
connector/forwardconnector/ @open-telemetry/collector-approvers
22+
connector/xconnector/ @open-telemetry/collector-approvers @mx-psi @dmathieu
23+
24+
consumer/xconsumer/ @open-telemetry/collector-approvers @mx-psi @dmathieu
25+
26+
docs/rfcs/ @open-telemetry/collector-approvers @codeboten @BogdanDrutu @dmitryax @mx-psi
27+
28+
exporter/debugexporter/ @open-telemetry/collector-approvers @andrzej-stencel
29+
exporter/exporterhelper/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
30+
exporter/exporterhelper/xexporterhelper/ @open-telemetry/collector-approvers @mx-psi @dmathieu
31+
exporter/nopexporter/ @open-telemetry/collector-approvers @evan-bradley
32+
exporter/otlpexporter/ @open-telemetry/collector-approvers
33+
exporter/otlphttpexporter/ @open-telemetry/collector-approvers
34+
exporter/xexporter/ @open-telemetry/collector-approvers @mx-psi @dmathieu
35+
36+
extension/memorylimiterextension/ @open-telemetry/collector-approvers
37+
extension/xextension/ @open-telemetry/collector-approvers @swiatekm
38+
extension/zpagesextension/ @open-telemetry/collector-approvers
39+
40+
pdata/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
41+
pdata/pprofile/ @open-telemetry/collector-approvers @mx-psi @dmathieu
42+
43+
processor/batchprocessor/ @open-telemetry/collector-approvers
44+
processor/memorylimiterprocessor/ @open-telemetry/collector-approvers
45+
processor/processorhelper/ @open-telemetry/collector-approvers
46+
processor/xprocessor/ @open-telemetry/collector-approvers @mx-psi @dmathieu
47+
48+
receiver/nopreceiver/ @open-telemetry/collector-approvers @evan-bradley
49+
receiver/otlpreceiver/ @open-telemetry/collector-approvers
50+
receiver/receiverhelper/ @open-telemetry/collector-approvers
51+
receiver/xreceiver/ @open-telemetry/collector-approvers @mx-psi @dmathieu
52+
53+
scraper/ @open-telemetry/collector-approvers
54+
scraper/scraperhelper/ @open-telemetry/collector-approvers
55+
56+
service/ @open-telemetry/collector-approvers
57+
service/internal/graph/ @open-telemetry/collector-approvers @djaglowski
58+
59+
#####################################################
60+
#
61+
# List of distribution maintainers
62+
#
63+
#####################################################
64+
65+
reports/distributions/core.yaml @open-telemetry/collector-approvers
66+
reports/distributions/contrib.yaml @open-telemetry/collector-approvers
67+
reports/distributions/k8s.yaml @open-telemetry/collector-approvers
68+
reports/distributions/otlp.yaml @open-telemetry/collector-approvers
69+
#####################################################
70+
#
71+
## UNMAINTAINED components
72+
#
73+
#####################################################

‎.github/ISSUE_TEMPLATE/bug_report.md

-33
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+123
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage and track down your bug as quickly as possible.
9+
10+
Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if an existing issue covers your bug.
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: Component(s)
15+
description: Which component(s) does your bug report concern?
16+
multiple: true
17+
options:
18+
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
19+
# Do not manually edit it.
20+
# Start Collector components list
21+
- cmd/mdatagen
22+
- cmd/mdatagen/internal/sampleprocessor
23+
- cmd/mdatagen/internal/samplereceiver
24+
- cmd/mdatagen/internal/samplescraper
25+
- confmap
26+
- connector/forward
27+
- connector/x
28+
- consumer/xconsumer
29+
- docs/rfcs
30+
- exporter/debug
31+
- exporter/exporterhelper
32+
- exporter/exporterhelper/xexporterhelper
33+
- exporter/nop
34+
- exporter/otlp
35+
- exporter/otlphttp
36+
- exporter/x
37+
- extension/memorylimiter
38+
- extension/x
39+
- extension/zpages
40+
- pdata
41+
- pdata/pprofile
42+
- processor/batch
43+
- processor/memorylimiter
44+
- processor/processorhelper
45+
- processor/x
46+
- receiver/nop
47+
- receiver/otlp
48+
- receiver/receiverhelper
49+
- receiver/x
50+
- scraper
51+
- scraper/scraperhelper
52+
- service
53+
- service/internal/graph
54+
# End Collector components list
55+
- type: textarea
56+
attributes:
57+
label: What happened?
58+
description: Please provide as much detail as you reasonably can.
59+
value: |
60+
**Describe the bug**
61+
<!-- A clear and concise description of what the bug is. -->
62+
63+
**Steps to reproduce**
64+
<!-- If possible, provide a recipe for reproducing the error. -->
65+
66+
**What did you expect to see?**
67+
<!-- A clear and concise description of what you expected to see. -->
68+
69+
**What did you see instead?**
70+
<!-- A clear and concise description of what you saw instead. -->
71+
72+
validations:
73+
required: true
74+
- type: input
75+
attributes:
76+
label: Collector version
77+
description: What version did you use? (e.g., `v0.4.0`, `1eb551b`, etc)
78+
validations:
79+
required: true
80+
- type: textarea
81+
attributes:
82+
label: Environment information
83+
description: Please provide any additional information about your installation.
84+
value: |
85+
## Environment
86+
OS: (e.g., "Ubuntu 20.04")
87+
Compiler(if manually compiled): (e.g., "go 14.2")
88+
89+
- type: textarea
90+
attributes:
91+
label: OpenTelemetry Collector configuration
92+
description: Please provide the configuration you are using (e.g. the YAML config file).
93+
placeholder: | # Empty Collector config
94+
receivers:
95+
exporters:
96+
processors:
97+
extensions:
98+
service:
99+
pipelines:
100+
traces:
101+
receivers: []
102+
exporters: []
103+
processors: []
104+
metrics:
105+
receivers: []
106+
exporters: []
107+
processors: []
108+
logs:
109+
receivers: []
110+
exporters: []
111+
processors: []
112+
render: yaml
113+
- type: textarea
114+
attributes:
115+
label: Log output
116+
description: |
117+
Please copy and paste any relevant log output.
118+
render: shell
119+
- type: textarea
120+
attributes:
121+
label: Additional context
122+
description: Any additional information you think may be relevant to this issue.
123+

‎.github/ISSUE_TEMPLATE/feature_request.md

-29
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["feature request"]
4+
body:
5+
- type: dropdown
6+
id: component
7+
attributes:
8+
label: Component(s)
9+
description: Which component(s) does your feature request concern?
10+
multiple: true
11+
options:
12+
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
13+
# Do not manually edit it.
14+
# Start Collector components list
15+
- cmd/mdatagen
16+
- cmd/mdatagen/internal/sampleprocessor
17+
- cmd/mdatagen/internal/samplereceiver
18+
- cmd/mdatagen/internal/samplescraper
19+
- confmap
20+
- connector/forward
21+
- connector/x
22+
- consumer/xconsumer
23+
- docs/rfcs
24+
- exporter/debug
25+
- exporter/exporterhelper
26+
- exporter/exporterhelper/xexporterhelper
27+
- exporter/nop
28+
- exporter/otlp
29+
- exporter/otlphttp
30+
- exporter/x
31+
- extension/memorylimiter
32+
- extension/x
33+
- extension/zpages
34+
- pdata
35+
- pdata/pprofile
36+
- processor/batch
37+
- processor/memorylimiter
38+
- processor/processorhelper
39+
- processor/x
40+
- receiver/nop
41+
- receiver/otlp
42+
- receiver/receiverhelper
43+
- receiver/x
44+
- scraper
45+
- scraper/scraperhelper
46+
- service
47+
- service/internal/graph
48+
# End Collector components list
49+
- type: textarea
50+
attributes:
51+
label: Is your feature request related to a problem? Please describe.
52+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. We are currently preparing for the upcoming 1.0 GA release. Feature requests that are not aligned with the current roadmap and are not aimed at stabilizing and preparing the Collector for the release will
53+
not be prioritized.
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Describe the solution you'd like
59+
description: A clear and concise description of what you want to happen.
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: Describe alternatives you've considered
65+
description: A clear and concise description of any alternative solutions or features you've considered.
66+
- type: textarea
67+
attributes:
68+
label: Additional context
69+
description: Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)