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

Change repo default branches from master to main #107

Closed
1 of 33 tasks
Yonet opened this issue Jun 16, 2020 · 11 comments
Closed
1 of 33 tasks

Change repo default branches from master to main #107

Yonet opened this issue Jun 16, 2020 · 11 comments
Assignees

Comments

@Yonet Yonet self-assigned this Jun 16, 2020
@himorin
Copy link
Member

himorin commented Jun 16, 2020

note, I think most of these repositories uses gh-pages for source branch of github pages, but wait for our (W3C team)'s investigation on how to configure to use main branch as their source if master is source currently.

@Yonet
Copy link
Member Author

Yonet commented Jun 22, 2020

@himorin thank you, I'll wait.

@himorin
Copy link
Member

himorin commented Jun 22, 2020

As for now:

  • All WG repos use gh-pages for github pages, and master
  • In CG,
    • use gh-pages for github pages, and master: 'Anchors', 'Layers'
    • master is used, no github pages: 'Computer Vision', 'geo-alignment', 'lighting-estimation', 'navigation', 'performance-improvements', 'real-world-geometry', 'spatial-favicons', 'webxr-hands-input'
  • In Others
    • master is used, no github pages: 'administrivia', 'privacy-and-security', 'proposals ', 'community-resources',
    • master is used, and also for github pages: 'immersiveweb.dev', 'homepage', 'webxr-samples', 'webxr-polyfill', 'webvr-polyfill', 'cardboard-vr-display', 'immersive-web.github.io', 'webvr-polyfill-dpdb', 'webxr-reference', 'webvr'
    • use gh-pages for github pages, and master: 'webxr-input-profiles', 'webxr-test-api', 'webvrrocks',

I think 'AR common' repo listed in WG is others (no github pages, not actively used)?

@Yonet
Copy link
Member Author

Yonet commented Jun 25, 2020

@himorin is it ok to change the master branches in any of them? Would anything, like the IPR tool be affected by the change? If not, we can just rename the master branch to main and set it as the default branch.

@himorin
Copy link
Member

himorin commented Jun 25, 2020

I believe IPR tool picks PR notification, but not checking repositories directly. (also PR notification contains branch of PR source and target to merge)
For ones with 'no github pages', I think we are fine to rename.
I'm not sure for ones with 'gh-pages for github pages', by mean of how external tool (like travis for generating gh-pages) works. For these, I think we'd better to wait verification by W3C team (@dontcallmedom, any further comment?).

@dontcallmedom
Copy link
Member

as @himorin said, the IPR tool doesn't deal with branches directly, so we don't need to worry about it.

From our early investigation, there are 2 main challenges in renaming master to main:

  • anybody who has a local clone of the repo will have to update their local config to point to the new upstream branch
  • only master and gh-pages can be used as a source of github.io pages - so for any repo where master is directly the source of github.io, renaming it to main is not an option at the moment

Beyond these, there are additional checks to keep in mind:

  • update any CI process that might refer to master explicitly (e.g. in travis.yml)
  • update the branch protection rules that might have been set specifically for master

@himorin
Copy link
Member

himorin commented Jul 20, 2020

(for record. github provides notes: https://github.com/github/renaming )

@TrevorFSmith
Copy link

Please don't change the immersive-web-weekly repo over to main. I started out using that but GitHub depends on master/docs/ to serve immersivewebweekly.com and there's currently no way to serve main/docs/, only a separate branch if there is no master.

Hopefully GitHub will eventually make it possible to serve a site from /docs/ from the default branch (no matter its name) but they're not there, yet.

@lazerwalker
Copy link

lazerwalker commented Jul 20, 2020

For what it's worth, it's possible/straight-forward to set up a minimal GitHub Action that deploys a given directory in the current branch to GitHub Pages whenever new commits are pushed.

I suspect it's not worth adding that deployment complexity now rather than waiting for GH to finish their default branch migration work, but throwing out that I'm happy to contribute the time to get that infrastructure in place if it's desired.

@himorin
Copy link
Member

himorin commented Nov 10, 2020

hi, sorry that I've left this untouched for long.
github added a feature to choose a branch for github pages other than gh-pages or master, so I think we can go ahead for this point.
I suppose mass update at one time over all repository might be better for participants (not to make confusion between repositories), and also we need to take some time for announcement.
how do you all think?

@himorin
Copy link
Member

himorin commented Feb 8, 2021

finished all, and see no issue. closing this.

@himorin himorin closed this as completed Feb 8, 2021
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

No branches or pull requests

5 participants