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

Add support for using the OpenTelemetry chloggen tool #923

Merged
merged 13 commits into from
Sep 29, 2023

Conversation

jvoravong
Copy link
Contributor

@jvoravong jvoravong commented Sep 12, 2023

Description

This PR brings several enhancements to the Makefile, introducing new utility functions, support for chloggen, and pre-commit checks.

Updated Makefile with New Actions

  • install-tools: Installs required tools for CI/CD workflows using Homebrew and Go. Currently supports only MacOS and Linux.
  • Changelog Management with chloggen: Added utility functions to create and manage changelog entries in .chloggen/. These entries will be used to automatically populate CHANGELOG.md during each release.
    • Pre-commit Check: Added a pre-commit hook that fails if a changelog entry is required. This is triggered when the Helm chart templates or rendered examples are updated.
  • Other Utility Functions: Added another utility make help.

Testing

The changes were manually tested.

Documentation

  • Updated CONTRIBUTING.md to reflect the new Makefile actions and the introduction of chloggen.

make help sample:

jvoravong@X splunk-otel-collector-chart % make help

Usage:
  make <target>

General
  help             Display Makefile help information for all actions

Initialization
  install-tools    Install tools (macOS/Linux)

Build
  repo-update      Update Helm repositories to latest
  dep-build        Build the Helm chart with latest dependencies from the current Helm repositories
  render           Render the Helm chart with the examples as input

Changelog
  chlog-available  Validate the chloggen tool is available
  chlog-new        Creates or updates a YAML file under .chloggen
  chlog-validate   Validates changelog requirements for pull requests
  chlog-preview    Provide a preview of the generated CHANGELOG.md file for a release
  chlog-update     Creates an update to CHANGELOG.md for a release entry from content in .chloggen

make chlog-release VERSION=0.85.0 sample:

# Changelog

## [0.85.0] - 2023-09-18

### 💡 Enhancements 💡

This Splunk OpenTelemetry Collector for Kubernetes release adopts the [Splunk OpenTelemetry Collector v0.84.0](https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.84.0).

- `chart`: Add support for OpenTelemetry CHANGELOG.md generator tool, see [chloggen](https://github.com/open-telemetry/opentelemetry-operator/tree/main/.chloggen) ([#923](https://github.com/signalfx/splunk-otel-collector-chart/pull/923))
- `agent`: Update Splunk Fluentd HEC docker image to v1.3.3 ([#924](https://github.com/signalfx/splunk-otel-collector-chart/pull/924))

## [0.84.0] - 2023-09-11

@jvoravong jvoravong force-pushed the otl-add-chloggen branch 7 times, most recently from 26073f3 to 4fc13c8 Compare September 18, 2023 17:17
@jvoravong jvoravong marked this pull request as ready for review September 18, 2023 17:17
@jvoravong jvoravong requested review from a team as code owners September 18, 2023 17:17
@jvoravong jvoravong force-pushed the otl-add-chloggen branch 6 times, most recently from 1cee6b3 to aa1a101 Compare September 18, 2023 18:06
Copy link
Contributor

@hughesjj hughesjj left a comment

Choose a reason for hiding this comment

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

looks good but want to know about that odd step name

.github/workflows/lint-test.yaml Outdated Show resolved Hide resolved
@jvoravong jvoravong force-pushed the otl-add-chloggen branch 6 times, most recently from a525a41 to be7a3d5 Compare September 18, 2023 21:06
@jvoravong
Copy link
Contributor Author

Going to adopt changes from #917 before the next commit for this PR.

@jvoravong jvoravong marked this pull request as draft September 20, 2023 15:22
.pre-commit-config.yaml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
@jvoravong
Copy link
Contributor Author

Addressed PR comments and separated code out where possible. Executing final testing in GitHub workflows and then this should be ready to review.

@atoulme
Copy link
Contributor

atoulme commented Sep 26, 2023

Did you have a separate PR for the code you separated?

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@atoulme atoulme left a comment

Choose a reason for hiding this comment

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

LGTM, one nit

Co-authored-by: Antoine Toulme <[email protected]>
@jvoravong
Copy link
Contributor Author

Did you have a separate PR for the code you separated?

Haven't created it yet. Will do shortly.

@jvoravong jvoravong marked this pull request as ready for review September 29, 2023 14:37
@jvoravong jvoravong requested a review from hughesjj September 29, 2023 14:38
@jvoravong jvoravong merged commit 5a22bbd into signalfx:main Sep 29, 2023
19 checks passed
@jvoravong jvoravong deleted the otl-add-chloggen branch September 29, 2023 17:12
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.

3 participants