search

opensearch-project / skills

Apache License 2.0
6 stars 29 forks source link

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

Open gaiksaya opened 5 months ago

gaiksaya commented 5 months ago

What is the bug?

The release notes for 2.13.0 (https://github.com/opensearch-project/skills/blob/main/release-notes/opensearch-skills.release-notes-2.13.0.0.md#dependencies) 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 skills under NON-COMPLAINT banner:

<h2>NON-COMPLIANT</h2>
<h2>DEPENDENCIES</h2>
<h3>Opensearch Skills</h3>
<ul>
<li>Update mockito monorepo to v5.10.0 (#128) (#197)</li>
<li>Update dependency org.apache.commons:commons-lang3 to v3.14.0 (#47)</li>
<li>Update dependency org.apache.commons:commons-text to v1.11.0 (#62)</li>
<li>Update plugin io.freefair.lombok to v8.6 (#245) (#249)</li>
<li>Update plugin de.undercouch.download to v5.6.0 (#239) (#250)</li>
<li>Update plugin com.diffplug.spotless to v6.25.0 (#127) (#252)</li>
<li>Update dependency org.json:json to v20240205 (#246) (#251)</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.

dblock commented 2 months ago

Catch All Triage - 1 2 3 4 5 6