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

[BUG] Release notes do not follow standard guidelines #131

Closed
gaiksaya opened this issue Mar 29, 2024 · 1 comment · Fixed by #132
Closed

[BUG] Release notes do not follow standard guidelines #131

gaiksaya opened this issue Mar 29, 2024 · 1 comment · Fixed by #132
Labels
bug Something isn't working untriaged

Comments

@gaiksaya
Copy link
Member

gaiksaya commented Mar 29, 2024

What is the bug?

The release notes for 2.13.0 (https://github.com/opensearch-project/custom-codecs/blob/main/release-notes/opensearch-custom-codecs.release-notes-2.13.0.0.md) do not follow the standard guidelines mentioned here: https://github.com/opensearch-project/opensearch-plugins/blob/main/RELEASE_NOTES.md

Due to this the automation in https://github.com/opensearch-project/opensearch-build/tree/main/src/release_notes_workflow breaks and the release manager has to manually sort the PRs.

How can one reproduce the bug?

Clone build repo and run ./release_notes.sh compile manifests/2.13.0/opensearch-2.13.0.yml --output opensearch.md
See custom-codecs under NON-COMPLAINT banner:

<h2>NON-COMPLIANT</h2>
<h2>CHANGED</h2>
<h3>Opensearch Custom Codecs</h3>
<ul>
<li>Remove unneccessary ArrayUtil.grow in Zstd compression modes. (<a href="https://github.com/opensearch-project/custom-codecs/pull/121">#121</a>)</li>
</ul>

What is the expected behavior?

Should not be under non-complaint banner but appropriate headings

What is your host/environment?

Operating system, version.

Do you have any screenshots?

If applicable, add screenshots to help explain your problem.

Do you have any additional context?

Add any other context about the problem.

@gaiksaya gaiksaya added bug Something isn't working untriaged labels Mar 29, 2024
@gaiksaya
Copy link
Member Author

Hi @reta @andrross
Can you please help and categorize the PR in this release notes? https://github.com/opensearch-project/custom-codecs/blob/main/release-notes/opensearch-custom-codecs.release-notes-2.13.0.0.md
Need to add it to consolidated release notes.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working untriaged
Projects
None yet
1 participant