Skip to content

Remove manual CHANGELOG.md process - #907

Merged
cwperks merged 1 commit into
opensearch-project:mainfrom
cwperks:remove-changelog
Apr 21, 2026
Merged

cwperks merged 1 commit into
opensearch-project:mainfrom
cwperks:remove-changelog

Conversation

@cwperks

@cwperks cwperks commented Apr 6, 2026

Copy link
Copy Markdown
Member

Description

The CHANGELOG.md file has been a source of merge conflicts and has still resulted in poor quality release notes. Release notes will now be generated from PR and commit metadata instead. See opensearch-project/OpenSearch#21071 for the proposal and opensearch-project/OpenSearch#21083 for the equivalent change in core OpenSearch.

Changes

  • Replace CHANGELOG.md content with a redirect to the PR search and release notes tooling docs
  • Delete .github/workflows/changelog_verifier.yml (note: this workflow was checking security-dashboards-plugin in its if condition, so it was never actually running for this repo)

Related Issues

Resolves opensearch-project/OpenSearch#21071

Check List

  • Commits are signed per the DCO using --signoff.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

The CHANGELOG.md file has been a source of merge conflicts and has
still resulted in poor quality release notes. Release notes will
now be generated from PR and commit metadata instead.

Signed-off-by: Craig Perkins <cwperx@amazon.com>
@cwperks
cwperks force-pushed the remove-changelog branch from ad21cfa to e555f6e Compare April 6, 2026 14:10
@codecov

codecov Bot commented Apr 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.38%. Comparing base (3d9091a) to head (e555f6e).
⚠️ Report is 3 commits behind head on main.

❌ Your project status has failed because the head coverage (70.38%) is below the target coverage (75.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #907      +/-   ##
==========================================
- Coverage   70.48%   70.38%   -0.10%     
==========================================
  Files          42       42              
  Lines        2060     2060              
  Branches      164      164              
==========================================
- Hits         1452     1450       -2     
- Misses        499      501       +2     
  Partials      109      109              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dbwiddis dbwiddis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! Clean removal of the manual CHANGELOG process, aligned with the org-wide initiative in opensearch-project/OpenSearch#21071. Good catch that the changelog_verifier.yml was checking security-dashboards-plugin and never actually ran for this repo. The Codecov project check failure is a pre-existing coverage gap, unrelated to this PR (no source code changed).

@cwperks
cwperks merged commit f16b8ce into opensearch-project:main Apr 21, 2026
15 of 16 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 In Review to ✅ Done in Engineering Effectiveness Board Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

[PROPOSAL] Replace CHANGELOG.md with automated release notes generation

2 participants