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

1.0.0 changelog: mention no breaking changes #1598

Merged
merged 1 commit into from
Feb 5, 2022

Conversation

aviau
Copy link
Contributor

@aviau aviau commented Feb 4, 2022

I know this is a past release but some of us are still migrating from ES and a big BREAKING CHANGES with title 10 thousand things under it is scary until you realize its an empty section. 🙃

@aviau aviau requested a review from a team as a code owner February 4, 2022 19:26
@peterzhuamazon
Copy link
Member

Hi @aviau sorry that this is a miss from our side.
Can you consider completely remove the Breaking Changes section?
This is also our standard practice since ODFE.

Thanks.

@aviau
Copy link
Contributor Author

aviau commented Feb 4, 2022

@peterzhuamazon done!

@peterzhuamazon peterzhuamazon requested a review from zelinh February 4, 2022 20:03
@peterzhuamazon peterzhuamazon added the documentation Improvements or additions to documentation label Feb 4, 2022
Copy link
Member

@zelinh zelinh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@peterzhuamazon
Copy link
Member

@aviau you need to sign off DCO.
Please do git commit --amend --no-edit -s -S and push again.
Thanks.

Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that we should remove this section, its important to call out that we did not introduce any breaking changes.

Could you help me understand how when you saw the release notes it looked like there were many breaking changes, maybe a screenshot?

@aviau
Copy link
Contributor Author

aviau commented Feb 4, 2022

I won't put any more efforts here for something so pedantic, I think my issue description is self-explainatory. Empty sections aren't obvious in rendered markdown. If you don't agree then please just close my PR.

@dblock
Copy link
Member

dblock commented Feb 4, 2022

I think it should either say None or be removed. Don’t care either way.

@aviau thank you!

@peternied ok merging as is or do you want to PR an alternative?

@peternied
Copy link
Member

@aviau Thanks for the contribution - lets merge this as is and we can make additional PRs in the future.

There is an issue #438 tracking the codification of the release notes process.

@peternied peternied merged commit 37ae82f into opensearch-project:main Feb 5, 2022
@aviau aviau deleted the patch-1 branch February 13, 2022 14:24
peterzhuamazon pushed a commit to peterzhuamazon/opensearch-build that referenced this pull request Feb 16, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants