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

[Improvement] Release Notes workflow Quality of Life Improvement and Standardization #4504

Closed
peterzhuamazon opened this issue Mar 5, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers release

Comments

@peterzhuamazon
Copy link
Member

Hi,

As of now, the consolidated release notes workflows has been automated using MarkdownTableWriter from pytablewriter.

There are, however, multiple aspects to be improved for the future.

  1. The release notes is now in html format instead of the markdown, which add up complexity on maintenance and reduce readability without a render. Example: https://raw.githubusercontent.com/opensearch-project/opensearch-build/2.12.0/release-notes/opensearch-release-notes-2.12.0.md.
  2. The workflow can compile either OpenSearch or OpenSearch-Dashboards consolidated release notes, but is not able to put them both together into one file. This add up efforts for the release manager to manually combine both into a final release notes PR.

We are looking for ways to resolve the above two issues with some quality of life improvements.

Thanks.

@peterzhuamazon peterzhuamazon added documentation Improvements or additions to documentation good first issue Good for newcomers release labels Mar 5, 2024
@github-actions github-actions bot added the untriaged Issues that have not yet been triaged label Mar 5, 2024
@bbarani
Copy link
Member

bbarani commented Mar 28, 2024

@peterzhuamazon Do you have any recommendation?

@rishabh6788 rishabh6788 removed the untriaged Issues that have not yet been triaged label Apr 1, 2024
@rishabh6788 rishabh6788 self-assigned this Apr 1, 2024
@rishabh6788
Copy link
Collaborator

Will take a look.

@rishabh6788
Copy link
Collaborator

Fixed as part of PR #4627

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers release
Projects
Development

No branches or pull requests

3 participants