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
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
5b402a4
[chore] enhance issue templates
mowies Nov 26, 2024
369ef88
add other issue template
mowies Nov 26, 2024
6262405
add githubgen tool
mowies Nov 26, 2024
c3877ef
add githubgen makefile commands
mowies Nov 26, 2024
e76d5a9
correct go module name
mowies Nov 27, 2024
b3b212f
generate new issue template components
mowies Nov 27, 2024
698941c
update allowlist
mowies Nov 27, 2024
046c0f5
add metadata file for rfc folder, update issue templates accordingly
mowies Nov 27, 2024
12f1d08
update githubgen tool to generate correct owners file
mowies Nov 27, 2024
f04c2ee
remove user some from mdatagen test components to not put them into o…
mowies Nov 27, 2024
5b97e06
make gogenerate
mowies Nov 27, 2024
6d3dd88
add githubgen to version.yaml
mowies Nov 27, 2024
44f16cc
fix linter errors
mowies Nov 27, 2024
3a427aa
fix module name
mowies Dec 4, 2024
06654e7
make crosslink
mowies Dec 4, 2024
ef99e30
tidy
mowies Dec 4, 2024
d238124
remove duplicated githubgen tool
mowies Jan 13, 2025
b021726
add githubgen to tools
mowies Jan 13, 2025
249f03a
update issue templates with githubgen
mowies Jan 16, 2025
d5aedac
update allowlist with new template
mowies Jan 16, 2025
42b4a8a
add makefile entries for githubgen
mowies Jan 20, 2025
869d11e
codeowners template adaptations
mowies Jan 20, 2025
23f8686
add missing metadata files to get back to old codeowners list
mowies Jan 20, 2025
428dcd8
make gengithub
mowies Jan 20, 2025
0b1a71e
Merge branch 'main' into enhance-issue-template
mowies Jan 20, 2025
0874269
go mod tidy internal/tools
mowies Jan 20, 2025
573417f
make gengithub
mowies Jan 20, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/ALLOWLIST
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Code generated by githubgen. DO NOT EDIT.
#####################################################
#
# List of components
# waiting on owners to be assigned
#
#####################################################
#
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
#

##
# NOTE: New components MUST have one or more codeowners. Add codeowners to the component metadata.yaml and run make gengithub
##

## COMMON & SHARED components
internal/common

## DEPRECATED components

## UNMAINTAINED components
91 changes: 63 additions & 28 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,37 +1,72 @@
# Code generated by githubgen. DO NOT EDIT.
#####################################################
#
# List of approvers for OpenTelemetry Collector
# List of codeowners
#
#####################################################
#
# Learn about membership in OpenTelemetry community:
# https://github.com/open-telemetry/community/blob/main/community-membership.md
#
#
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
#

* @open-telemetry/collector-approvers

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

confmap/ @open-telemetry/collector-approvers @mx-psi @evan-bradley
exporter/debugexporter @open-telemetry/collector-approvers @andrzej-stencel
exporter/exporterhelper @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
exporter/nopexporter @open-telemetry/collector-approvers @evan-bradley
pdata/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
receiver/nopreceiver @open-telemetry/collector-approvers @evan-bradley
service/internal/graph @open-telemetry/collector-approvers @djaglowski
extension/xextension @open-telemetry/collector-approvers @swiatekm

# Profiling-related modules
pdata/pprofile @open-telemetry/collector-approvers @mx-psi @dmathieu
consumer/xconsumer @open-telemetry/collector-approvers @mx-psi @dmathieu
connector/xconnector @open-telemetry/collector-approvers @mx-psi @dmathieu
exporter/exporterhelper/xexporterhelper @open-telemetry/collector-approvers @mx-psi @dmathieu
exporter/xexporter @open-telemetry/collector-approvers @mx-psi @dmathieu
processor/xprocessor @open-telemetry/collector-approvers @mx-psi @dmathieu
receiver/xreceiver @open-telemetry/collector-approvers @mx-psi @dmathieu
cmd/mdatagen/ @open-telemetry/collector-approvers @dmitryax
cmd/mdatagen/internal/sampleprocessor/ @open-telemetry/collector-approvers
cmd/mdatagen/internal/samplereceiver/ @open-telemetry/collector-approvers @dmitryax
cmd/mdatagen/internal/samplescraper/ @open-telemetry/collector-approvers @dmitryax

confmap/ @open-telemetry/collector-approvers @mx-psi @evan-bradley

connector/forwardconnector/ @open-telemetry/collector-approvers
connector/xconnector/ @open-telemetry/collector-approvers @mx-psi @dmathieu

consumer/xconsumer/ @open-telemetry/collector-approvers @mx-psi @dmathieu

docs/rfcs/ @open-telemetry/collector-approvers @codeboten @BogdanDrutu @dmitryax @mx-psi

exporter/debugexporter/ @open-telemetry/collector-approvers @andrzej-stencel
exporter/exporterhelper/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
exporter/exporterhelper/xexporterhelper/ @open-telemetry/collector-approvers @mx-psi @dmathieu
exporter/nopexporter/ @open-telemetry/collector-approvers @evan-bradley
exporter/otlpexporter/ @open-telemetry/collector-approvers
exporter/otlphttpexporter/ @open-telemetry/collector-approvers
exporter/xexporter/ @open-telemetry/collector-approvers @mx-psi @dmathieu

extension/memorylimiterextension/ @open-telemetry/collector-approvers
extension/xextension/ @open-telemetry/collector-approvers @swiatekm
extension/zpagesextension/ @open-telemetry/collector-approvers

pdata/ @open-telemetry/collector-approvers @BogdanDrutu @dmitryax
pdata/pprofile/ @open-telemetry/collector-approvers @mx-psi @dmathieu

processor/batchprocessor/ @open-telemetry/collector-approvers
processor/memorylimiterprocessor/ @open-telemetry/collector-approvers
processor/processorhelper/ @open-telemetry/collector-approvers
processor/xprocessor/ @open-telemetry/collector-approvers @mx-psi @dmathieu

receiver/nopreceiver/ @open-telemetry/collector-approvers @evan-bradley
receiver/otlpreceiver/ @open-telemetry/collector-approvers
receiver/receiverhelper/ @open-telemetry/collector-approvers
receiver/xreceiver/ @open-telemetry/collector-approvers @mx-psi @dmathieu

scraper/ @open-telemetry/collector-approvers
scraper/scraperhelper/ @open-telemetry/collector-approvers

service/ @open-telemetry/collector-approvers
service/internal/graph/ @open-telemetry/collector-approvers @djaglowski

#####################################################
#
# List of distribution maintainers
#
#####################################################

reports/distributions/core.yaml @open-telemetry/collector-approvers
reports/distributions/contrib.yaml @open-telemetry/collector-approvers
reports/distributions/k8s.yaml @open-telemetry/collector-approvers
#####################################################
#
## UNMAINTAINED components
#
#####################################################
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

111 changes: 111 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
name: Bug report
description: Create a report to help us improve
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
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.

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.
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) does your bug report concern?
multiple: true
options:
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# Do not manually edit it.
# Start Collector components list
- cmd/mdatagen
- cmd/mdatagen/internal/sampleprocessor
- cmd/mdatagen/internal/samplereceiver
- connector/forward
- docs/rfcs
- exporter/debug
- exporter/exporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- extension/memorylimiter
- extension/zpages
- processor/batch
- processor/memorylimiter
- processor/processorhelper
- receiver/nop
- receiver/otlp
- receiver/receiverhelper
- scraper
- scraper/scraperhelper
- service
# End Collector components list
- type: textarea
attributes:
label: What happened?
description: Please provide as much detail as you reasonably can.
value: |
**Describe the bug**
<!-- A clear and concise description of what the bug is. -->

**Steps to reproduce**
<!-- If possible, provide a recipe for reproducing the error. -->

**What did you expect to see?**
<!-- A clear and concise description of what you expected to see. -->

**What did you see instead?**
<!-- A clear and concise description of what you saw instead. -->

validations:
required: true
- type: input
attributes:
label: Collector version
description: What version did you use? (e.g., `v0.4.0`, `1eb551b`, etc)
validations:
required: true
- type: textarea
attributes:
label: Environment information
description: Please provide any additional information about your installation.
value: |
## Environment
OS: (e.g., "Ubuntu 20.04")
Compiler(if manually compiled): (e.g., "go 14.2")

- type: textarea
attributes:
label: OpenTelemetry Collector configuration
description: Please provide the configuration you are using (e.g. the YAML config file).
placeholder: | # Empty Collector config
receivers:
exporters:
processors:
extensions:
service:
pipelines:
traces:
receivers: []
exporters: []
processors: []
metrics:
receivers: []
exporters: []
processors: []
logs:
receivers: []
exporters: []
processors: []
render: yaml
- type: textarea
attributes:
label: Log output
description: |
Please copy and paste any relevant log output.
render: shell
- type: textarea
attributes:
label: Additional context
description: Any additional information you think may be relevant to this issue.

29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Feature request
description: Suggest an idea for this project
labels: ["feature request"]
body:
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) does your feature request concern?
multiple: true
options:
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# Do not manually edit it.
# Start Collector components list
- cmd/mdatagen
- cmd/mdatagen/internal/sampleprocessor
- cmd/mdatagen/internal/samplereceiver
- connector/forward
- docs/rfcs
- exporter/debug
- exporter/exporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- extension/memorylimiter
- extension/zpages
- processor/batch
- processor/memorylimiter
- processor/processorhelper
- receiver/nop
- receiver/otlp
- receiver/receiverhelper
- scraper
- scraper/scraperhelper
- service
# End Collector components list
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
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
not be prioritized.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Other issue
description: Create a new issue to help us improve the collector
body:
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) does your issue concern?
multiple: true
options:
# NOTE: The list below is autogenerated using `make generate-gh-issue-templates`
# Do not manually edit it.
# Start Collector components list
- cmd/mdatagen
- cmd/mdatagen/internal/sampleprocessor
- cmd/mdatagen/internal/samplereceiver
- connector/forward
- docs/rfcs
- exporter/debug
- exporter/exporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- extension/memorylimiter
- extension/zpages
- processor/batch
- processor/memorylimiter
- processor/processorhelper
- receiver/nop
- receiver/otlp
- receiver/receiverhelper
- scraper
- scraper/scraperhelper
- service
# End Collector components list
- type: textarea
attributes:
label: Describe the issue you're reporting
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
Loading
Loading