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

Either update or remove the changelog document in the Migration dir #1157

Closed
4 tasks
okwme opened this issue Jan 12, 2022 · 3 comments
Closed
4 tasks

Either update or remove the changelog document in the Migration dir #1157

okwme opened this issue Jan 12, 2022 · 3 comments
Assignees

Comments

@okwme
Copy link
Contributor

okwme commented Jan 12, 2022

Summary

The migration dir of the docs of the gaia repo contains a breaking changes document: https://github.com/cosmos/gaia/blob/main/docs/migration/breaking_changes.md

This could be a good resource to direct different users to to let them know about breaking changes between versions of Gaia's upstream dependencies (Cosmos-SDK, Tendermint, IBC).

However this document is out of date and I question whether the format was suitable to make it as useful as possible. It contains all breaking changes instead of specifically breaking changes between versions of Gaia. It must have been difficult to keep this up to date as well.

I suggest removing it and committing to creating wholistic upgrade instructions between breaking releases of gaia where these changes are collated for specific users and specific instances.

Any thoughts?

Problem Definition

Proposal


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@glnro
Copy link
Contributor

glnro commented Feb 6, 2022

Agreed though I'm not sure where those new instructions would live, and where the best place to archive the existing document. What action items do we want coming from this issue?

@okwme
Copy link
Contributor Author

okwme commented Feb 14, 2022

these are inluded in our our changelog / release notes.

@okwme
Copy link
Contributor Author

okwme commented Apr 25, 2022

let's nuke em 💣

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants