[ENH][DOC] add instructions to existing users how to migrate their locar repos to main branch

[mikofski]

Is your feature request related to a problem? Please describe.
see #1584 - we plan to change the name of master branch to main, if we do, links on GH are updated, but users will have to follow directions to update their local repos

Describe the solution you'd like
Add a temporary section to the docs? announce on google groups

Describe alternatives you've considered
do nothing, just announce on g-group, point users to GH docs

Additional context
IMHO, I have dragged my feet too long on this, just need to do it asap. It will be confusing for a few days, then done

[mikofski]

I'm thinking something on this page: https://pvlib-python.readthedocs.io/en/stable/contributing.html

[wholmgren]

do nothing, just announce on g-group, point users to GH docs

This. The only people that will be effected are those that can deal with it with reasonable effort. No need to reinvent GH docs.

[mikofski]

@wholmgren then I suggest just go ahead and do it now. I'll post something on google groups linking to the discussion or the GH help docs

[mikofski]

FYI: @pvlib/pvlib-core - I can't make the change, I can't see the settings tab in pvlib

[cwhanse]

@mikofski simply rename master branch to main?

[mikofski]

I believe we can follow the steps here: https://github.com/github/renaming#renaming-existing-branches

and here: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch

then users do what it says here: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes

$ git branch -m OLD-BRANCH-NAME NEW-BRANCH-NAME
$ git fetch origin
$ git branch -u origin/NEW-BRANCH-NAME NEW-BRANCH-NAME
$ git remote set-head origin -a
$ git remote prune origin

[mikofski]

Here is what GH says when renaming master to main:

• Will update 36 pull requests targeting this branch across 23 repositories.
• Will update 1 branch protection rule that explicitly targets master.

instructions to update local environments:

git branch -m master <BRANCH>
git fetch origin
git branch -u origin/<BRANCH> <BRANCH>
git remote set-head origin -a

[mikofski]

OK, it's done. All contributors please update your local environments following GH instructions.

[mikofski]

note replace with "main" so:

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
git remote prune origin

[mikofski]

@pvlib/pvlib-core here's a wrinkle, my personal fork is not auto updated, I see this lovely GH message

so that's another step, to rename master branch in my personal fork as well!

[kandersolar]

git fetch origin

Probably most people will have origin set to their own fork, right? I have kanderso-nrel/pvlib-python as origin and pvlib/pvlib-python as upstream. I think people will need to rename the branch in their fork on github before these local commands are applicable.

Edit: I think @mikofski beat me by a µs

[mikofski]

Here's what the renaming process looked like for me, with my mistakes included 😉 😜

anyway, not too painful and all good now 👍 😺

[mikofski]

GH really holding our hands here, saw this on upstream:

[mikofski]

@kanderso-nrel I had one more wrinke, after updating origin and my local environment, I still had this:

So I reran the GH commands with "upstream" as you suggested

now all good