Skip to content

Commit

Permalink
add GitHub Action workflow and issue template (#9)
Browse files Browse the repository at this point in the history
Add files for GitHub Action and issue templates

* GitHub Action to build the custom collector
* Issue templates to feature request, bug report and pull request

ref: #7
  • Loading branch information
ymotongpoo committed Nov 13, 2023
1 parent 1c37ec3 commit 3402624
Show file tree
Hide file tree
Showing 4 changed files with 207 additions and 0 deletions.
101 changes: 101 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: Bug report
description: Create a report
labels:
- "bug"
- "needs triage"
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.
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) are you having issues with?
multiple: true
options:
- receiver/discord
- documentation
- CI/CD
validations:
required: true

- type: textarea
attributes:
label: What happened?
description: Please provide as much detail as you reasonably can.
value: |
## Description
## Steps to Reproduce
## Expected Result
## Actual Result
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 builder configuration
description: Please provide the collector build configuration you are using (e.g. the YAML config file).
placeholder: |
dist:
module: github.com/ymotongpoo/opentelemetry-collector-extra/builder
name: otelcol-custom
description: Custom OpenTelemetry Collector binary
output_path: .
receivers:
- gomod: go.opentelemetry.io/collector/receiver/otlpreceiver v0.88.0
processors:
- gomod: go.opentelemetry.io/collector/processor/batchprocessor v0.88.0
exporters:
- gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.88.0
render: yaml
- 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.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest an idea for this project
labels:
- "feature request"
- "needs triage"
body:
- type: dropdown
id: component
attributes:
label: Components
description: Which component(s) does this feature request relate to?
multiple: true
options:
- receiver/discord
- documentation
- CI/CD
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description the feature request is.
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.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Pull Request
about: Create a pull request.
title: ''
labels: ''
assignees: ''

---

_Please complete the following information before submitting your pull request._

## Issue Number

Please create an issue first even if the fix is trivial

## Description of change

What does this PR bring to the repository?

## Check List

- [ ] Passed the unit tests
- [ ] Built the custom collector without errors
- [ ] Added documentation for new features

## Additional context

Add any other context about the pull request
41 changes: 41 additions & 0 deletions .github/workflow/otelcol-build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Copyright 2023 Yoshi Yamaguchi
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: otelcol-build
run-name: Build custom OpenTelemetry Collector
on:
pull_request:
push:

jobs:
setup-ocb:
runs-on: ubuntu-latest
strategy:
matrix:
go-version: [1.20, 1.21]

steps:
- uses: actions/checkout@v4
- name: Setup Go ${{ matrix-go-version }}
uses: actions/setup-go@v4
with:
go-version: ${{ matrix.go-version }}
- name: Display Go Version
run: go version
- name: Install OCB
run: GO111MODULE=on go install go.opentelemetry.io/collector/cmd/builder@latest
- name: Build OpenTelemetry Collector (Linux)
run: CGO_ENABLED=0 GOOS=linux GOARCH=amd64 builder --config=otelcol-builder.yaml --name=otelcol-custom-linux
- name: Build OpenTelemetry Collector (macOS)
run: CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 builder --config=otelcol-builder.yaml --name=otelcol-custom-macos

0 comments on commit 3402624

Please sign in to comment.