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

Abandon master branch and make main default #1308

Closed
benjaoming opened this issue Aug 12, 2022 · 4 comments
Closed

Abandon master branch and make main default #1308

benjaoming opened this issue Aug 12, 2022 · 4 comments
Assignees
Labels
Needed: design decision A core team decision is required
Milestone

Comments

@benjaoming
Copy link
Contributor

There are known instances of projects that install directly from the master branch, rather than a PyPi package.

We can make the move to the new conventional main branch count by also dropping support of directly installing from master branch (or any other branch for that matter).

Benefits

  1. Assets should not be maintained and built directly in the repo
  2. Breaking changes for backwards Sphinx compatibility are coming and we do not know how this might affect very old deployments that rely on master.

Practical Proposal

  • Keep master but stop updating it
  • Freeze master after the 1.1.x release and set new default branch to main
  • Retarget any open PRs after 1.1.x release.
  • Start building non-tracked assets upon release, but do not change the build method for now (a reproducible one!). Write it down, preferably as a GitHub Action or similar.

Fallout / collateral

Fixes #1085 #1221 #379

Related: #1086

@benjaoming benjaoming added Needed: design decision A core team decision is required Priority: high High priority labels Aug 12, 2022
@benjaoming benjaoming added this to the 2.0 milestone Aug 12, 2022
@benjaoming benjaoming self-assigned this Aug 12, 2022
@agjohnson
Copy link
Collaborator

agjohnson commented Aug 17, 2022

Might be better to move this issue to #1221, this is a bit of a duplicate issue to that one.

@agjohnson agjohnson removed the Priority: high High priority label Aug 17, 2022
@agjohnson
Copy link
Collaborator

Let's continue discussion on #1221. The largest change from #1221 is how we handle installations directly pointing to our repository. We probably don't want to make the jump to main prematurely, if retaining master provides a way to effectively archive builds for users that are currently pip installing directly from our repo.

@benjaoming
Copy link
Contributor Author

We probably don't want to make the jump to main prematurely, if retaining master provides a way to effectively archive builds for users that are currently pip installing directly from our repo.

@agjohnson that was certainly not the intention, hence the word "abandon", not "delete"

@agjohnson
Copy link
Collaborator

Yeah, understood, I wasn't describing deleting either as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants