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

Document the different branches and their workflows #251

Closed
evan-forbes opened this issue Aug 7, 2022 · 8 comments
Closed

Document the different branches and their workflows #251

evan-forbes opened this issue Aug 7, 2022 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@evan-forbes
Copy link
Member

We use this repo for both the optimint and celestia forks of the cosmos-sdk, and to make it even more confusing we have important feature branches based on both of those (qgb, smt). We don't have good documentation as to which branches are used for what other than the names of the branch.

We should document the purpose, base, and status of each branch and keep it handy, perhaps even include this in the readme

@adlerjohn
Copy link
Member

adlerjohn commented Aug 7, 2022

We use this repo for both the optimint and celestia forks of the cosmos-sdk

That might actually be the biggest source of confusion. Both Celestia and Optimint use two different base branches, that may be updated independently, yet the default branch in the repo is for Celestia. What are our thoughts around splitting up this repo into cosmos-sdk-celestia and cosmos-sdk-optimint, that can each have their own project-centric default branches, release cycles, etc.? cc @liamsi @tzdybal

@jbowen93
Copy link

John and I discussed this offline. We agreed there should be distinct branches for the Cosmos-SDK version used for Celestia-App and the version used for Sovereign Rollups that use Optimint.

@tzdybal
Copy link
Member

tzdybal commented Aug 15, 2022

I like the idea of separate repositories to remove confusion.

@tzdybal
Copy link
Member

tzdybal commented Aug 18, 2022

You cannot fork a repo twice in same organization - it is not possible to make new repo that is a fork of original cosmos/cosmos-sdk in celestiaorg organization.

@musalbas
Copy link
Member

musalbas commented Sep 20, 2022

You cannot fork a repo twice in same organization - it is not possible to make new repo that is a fork of original cosmos/cosmos-sdk in celestiaorg organization.

You can, however, fork celestiaorg/cosmos-sdk in celestiaorg, which should achieve the same goal.

@rootulp
Copy link
Collaborator

rootulp commented Nov 6, 2023

It looks like Rollkit maintains https://github.com/rollkit/cosmos-sdk so perhaps this issue can be repurposed to document just the branches used by celestia-app. AFAIK that's currently only release/v0.46.x-celestia but we should also document main.

@rootulp
Copy link
Collaborator

rootulp commented Nov 15, 2023

I added a README in #356 that describes release/v0.46.x-celestia but it's not clear to me what main is for. @cmwaters what upstream branch does main track? What is main's purpose in this repo?

@rootulp rootulp added the documentation Improvements or additions to documentation label Nov 15, 2023
@rootulp
Copy link
Collaborator

rootulp commented Nov 16, 2023

Not documenting main and instead deprecating it in #359

@rootulp rootulp closed this as not planned Won't fix, can't repro, duplicate, stale Nov 16, 2023
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

No branches or pull requests

7 participants