opensearch-plugins icon indicating copy to clipboard operation
opensearch-plugins copied to clipboard

[FEATURE] Automate and standardize generation of release notes

Open dblock opened this issue 4 years ago • 0 comments

Is your feature request related to a problem?

  • Every plugin generates release notes in their own way, and either by hand or with semi-automation.
  • In version 1.2.2 the combined release notes for the OpenSearch product were largely incomplete, missing most plugins that did increment the log4j dependency, see https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.2.2.md.

What solution would you like?

  1. A release notes file is created and committed to the plugin repo every time a version is incremented.
  2. Release notes are automatically updated every time a change is made before a release or once after feature complete.
  3. Release notes are kept up-to-date with changes and can be verified as complete.

Do you have any additional context?

  • Some plugins have a create_release_notes.py checked in, e.g. https://github.com/opensearch-project/common-utils/blob/main/release-notes/create_release_notes.py. Can't tell how to use this.
  • this is how security plugin does it

dblock avatar Dec 20 '21 17:12 dblock