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

[RFC] rename repository branches #10079

Closed
thaJeztah opened this issue Dec 14, 2022 · 6 comments
Closed

[RFC] rename repository branches #10079

thaJeztah opened this issue Dec 14, 2022 · 6 comments
Assignees

Comments

@thaJeztah
Copy link
Member

Description

Relates to

When development for Compose v2 (reimplementation in Go) moved to this repository, the master branch (in which the code for the (now in "maintenance mode") Python implementation lives, was kept, and a new v2 branch was created and set as default branch.

Now that v2 is GA, and the default, we should consider:

  • renaming the old (python) branch from master to v1
  • renaming the (default) v2 branch to main

Opening this, as I have to fight muscle-memory every time I want to contribute to this repository 😂, and I can expect new contributors to this repository to also run into this (and possibly get confused).

⚠️ ❓ For go modules, renaming the branch should have no immediate consequences (unless someone does a go get github.com/docker/compose/v2@v2 to explicitly include the branch name), but I don't know if renaming the branch would have consequences for Python (don't think so?)

@thaJeztah
Copy link
Member Author

/cc @ndeloof @milas @glours

@glours
Copy link
Contributor

glours commented Dec 14, 2022

Hey @thaJeztah 👋

We didn't communicate publicly on this, but this exactly what we decided.
We can keep your issue open to let users know what will happen next April

@thaJeztah
Copy link
Member Author

Ah, cool! Wonder if this must be done together with the deprecation, or if we could already do this (I think it should be generally non-disruptive, so perhaps there's no need to wait).

@laurazard
Copy link
Member

laurazard commented Dec 19, 2022

Agreed! Would be nice to do this sooner rather than later. At first glance, I don't think anything would happen (any system automatically getting compose should be using the release URLs such as https://github.com/docker/compose/releases/download/.../... which stay the same). We can try to investigate a little bit just to make sure.

@thaJeztah
Copy link
Member Author

One warning; there was (or is?) a bug on GitHub, where renaming the branch does not update PRs that were opened from the web-ui (edit-button on GitHub). That workflow is probably less common on this repository as it is for the docs repository, but something to be aware of; see moby/mobywebsite#69 (comment) and docker/docs#14540 (comment)

@ndeloof ndeloof self-assigned this May 11, 2023
@ndeloof
Copy link
Contributor

ndeloof commented Oct 18, 2023

closing as done

@ndeloof ndeloof closed this as completed Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants