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

Replace single changelog with one for each gem. #127

Merged
merged 1 commit into from
Jan 9, 2023
Merged

Replace single changelog with one for each gem. #127

merged 1 commit into from
Jan 9, 2023

Conversation

nhtruong
Copy link
Collaborator

@nhtruong nhtruong commented Dec 5, 2022

With multiple gems coexisting in the same repo, the current framework for CHANGELOG.md is not suitable. We're going with a changelog for each gem and disable changelog verifier since it can't handle multiple change logs yet.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dblock
Copy link
Member

dblock commented Dec 16, 2022

But now we won't know what changed! What's the long term fix? I imagine we can combine the gems or have a CHANGELOG in each?

@nhtruong
Copy link
Collaborator Author

@dblock The commit messages will serve this purpose. Whenever you draft a new release, Github will pull the info of all commits since the last release for you to edit.

With 5 gems, each with its own version number, the long term solution is having a Changelog for each gem. It's the automated enforcement of changelog that's giving us trouble because it only works for 1 changelog file per repo. For now we're going to ask people to update the appropriate changelog when they offer a PR.

@nhtruong nhtruong changed the title Remove CHANGELOG.md Replace single changelog with one for each gem. Dec 19, 2022
@harshavamsi
Copy link
Collaborator

@nhtruong I don't think we need the dependabot_pr file anymore. It only updated the changelog for each dependabot PR.

harshavamsi
harshavamsi previously approved these changes Dec 19, 2022
@dblock
Copy link
Member

dblock commented Dec 20, 2022

LGTM, needs a rebase

With multiple gems coexisting in the same repo, the current framework for CHANGELOG.md is not suitable. We're going with a changelog for each gem and disable changelog verifier since it can't handle multiple change logs yet.

Signed-off-by: Theo Truong <[email protected]>
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

One of the problems with having all these gems in the same repo is tagging. Do we really want all of this to be lumped together if effectively we develop and release them separately? I opened #133 to discuss.

@nhtruong nhtruong merged commit 95219ca into opensearch-project:main Jan 9, 2023
@nhtruong nhtruong deleted the remove_changelog branch January 9, 2023 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants