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 Changelog verifier workflow #1413

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

owaiskazi19
Copy link
Member

Description

Add Changelog verifier workflow for creating release notes faster

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@opensearch-trigger-bot opensearch-trigger-bot bot added documentation Improvements or additions to documentation infra Changes to infrastructure, testing, CI/CD, pipelines, etc. backport 2.x labels Feb 3, 2025
@kaituo
Copy link
Collaborator

kaituo commented Feb 3, 2025

So this will allow creating changelog every time merge a PR?

@owaiskazi19
Copy link
Member Author

owaiskazi19 commented Feb 3, 2025

So this will allow creating changelog every time merge a PR?

Yes, devs need to add an entry into the CHANGELOG file every time they create a PR otherwise the CHANGELOG github action would fail.
For example this changelog entry was added with the bug fix.

Next time while creating the release notes all the entries can be copied directly to the release notes and can be deleted from either 2.x or 3.0 section as a clean up.
Example: https://github.com/opensearch-project/flow-framework/pull/1036/files

If for changes we don't need to add an entry for such PRs we can add skip-changelog label, that would pass the changelog workflow

Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.55%. Comparing base (d4ce6cf) to head (4e0877a).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #1413      +/-   ##
============================================
- Coverage     81.56%   81.55%   -0.02%     
- Complexity     5856     5860       +4     
============================================
  Files           533      533              
  Lines         23664    23664              
  Branches       2374     2374              
============================================
- Hits          19302    19299       -3     
- Misses         3197     3204       +7     
+ Partials       1165     1161       -4     
Flag Coverage Δ
plugin 81.55% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes

@kaituo
Copy link
Collaborator

kaituo commented Feb 3, 2025

So this will allow creating changelog every time merge a PR?

Yes, devs need to add an entry into the CHANGELOG file every time they create a PR otherwise the CHANGELOG github action would fail. For example this changelog entry was added with the bug fix.

Next time while creating the release notes all the entries can be copied directly to the release notes and can be deleted from either 2.x or 3.0 section as a clean up. Example: https://github.com/opensearch-project/flow-framework/pull/1036/files

If for changes we don't need to add an entry for such PRs we can add skip-changelog label, that would pass the changelog workflow

Can you document the process in https://github.com/opensearch-project/anomaly-detection/blob/main/DEVELOPER_GUIDE.md ?

@owaiskazi19 owaiskazi19 force-pushed the changelog branch 2 times, most recently from 6b52f9f to f581692 Compare February 3, 2025 23:07
ohltyler
ohltyler previously approved these changes Feb 4, 2025
amitgalitz
amitgalitz previously approved these changes Feb 4, 2025
@owaiskazi19
Copy link
Member Author

@kaituo BWC failure looks similar to opensearch-project/OpenSearch#15234. Is this safe to merge?

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
Signed-off-by: Owais <[email protected]>
@jackiehanyang jackiehanyang merged commit f8307ab into opensearch-project:main Feb 4, 2025
19 of 21 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 4, 2025
* Add Changelog verifier workflow

Signed-off-by: Owais <[email protected]>

* Add documentation

Signed-off-by: Owais <[email protected]>

---------

Signed-off-by: Owais <[email protected]>
(cherry picked from commit f8307ab)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
jackiehanyang pushed a commit that referenced this pull request Feb 4, 2025
* Add Changelog verifier workflow



* Add documentation



---------


(cherry picked from commit f8307ab)

Signed-off-by: Owais <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x documentation Improvements or additions to documentation infra Changes to infrastructure, testing, CI/CD, pipelines, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants