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

Rename master branch main #666

Merged
merged 2 commits into from May 26, 2022
Merged

Rename master branch main #666

merged 2 commits into from May 26, 2022

Conversation

jarrodmillman
Copy link
Collaborator

Close #549.

Here is what I think needs to be done:

  1. Rename default branch main on GitHub:
  2. Merge this PR
  3. I don't think you need to do anything for codecov.io.
  4. I don't use RTD, but I think you will need to follow these steps:
  5. Update your locally cloned repository to have a main branch as follows:
git branch -m master main
git fetch <YOUR_UPSTREAM_REMOTE>
git branch -u <YOUR_UPSTREAM_REMOTE>/main main

(where YOUR_UPSTREAM_REMOTE is typically called `upstream` or `origin`)

The whole process should only take a few minutes. You could send an email to developers telling them about step 5, if you want.

Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

+1 from me, I think we are overdue for this.

I'm happy to do the manual actions that @jarrodmillman notes above if there are no objections

@jarrodmillman jarrodmillman added this to the 0.9 milestone May 25, 2022
@jarrodmillman
Copy link
Collaborator Author

@choldgraf Any interest in making this change today? It shouldn't take long and it may be good to do it before the 0.9rc1.

@choldgraf
Copy link
Collaborator

I'm +1 on doing this today, as long as it won't create big headaches for @12rambau in #659 since he needs to resolve conflicts. If we don't think that'll be a big deal, then +1 from me (I just don't have the experience to know)

@12rambau
Copy link
Collaborator

Normally I solved everything in my PR if we can merge it before this one that would be perfect. Also @jarrodmillman could you copy/paste the instructions to change from master to main in an issue so that it can be pinned on top of the issue list it will be perfect (I'm positive I'm going to forget and I think I wont be the only one)

@choldgraf
Copy link
Collaborator

Great idea to pin those instructions in an issue. We can plan to close it in, say, 3 months.

@jarrodmillman
Copy link
Collaborator Author

I added a draft of the pinned issue:
#677

@choldgraf
Copy link
Collaborator

Thanks so much for your help @jarrodmillman 🙏

@jarrodmillman
Copy link
Collaborator Author

@choldgraf I think we are set to make the change. I don't have access to the repository settings, so you will need to do that. In my experience the process is painless and we have almost no remaining PRs (but they will be updated automatically). The only issue I've ever seen is that PR whose branch has been deleted are closed, but none of our existing PRs have that issue.

You should be able to follow the steps I list on my first comment on this issue.

@choldgraf
Copy link
Collaborator

choldgraf commented May 26, 2022

OK - I have:

  • Renamed the default branch for this repo in github
  • Did a quick look at the code for master to make sure we didn't miss something. It looked good, but I noticed we still used the Sphinx master_doc variable, which had since been renamed to root_doc. So I took the liberty of using that instead.
  • Will merge this if tests are happy
  • Will see if ReadTheDocs breaks, and if it does then I'll manually name the branch to main in RTD

@choldgraf choldgraf merged commit 14efafa into pydata:main May 26, 2022
@jarrodmillman jarrodmillman deleted the master2main branch May 26, 2022 05:33
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.

Rename master to main
3 participants