Rename "master" branches to "main"

ColinMaudry commented 3 years ago

Github is pushing for the name "master" to retire, replacing it with "main". Since October 1st, unless configured otherwise, all new repositories have their main branch named "main".

What's OCP strategy gonna be?

use "main" everywhere?
only use "main" on new repos?
keep "master"?
use something else such as "first", "best", "root", "god", "1", "0", "prod"? :trollface:

ColinMaudry commented 3 years ago

More info here: https://github.com/github/renaming/

jpmckinney commented 3 years ago

We'll wait for GitHub to prepare the tools to make it easier: https://github.com/github/renaming/#later-this-year

jpmckinney commented 3 years ago

[x] Change all default branches
[x] Update deploy repo (it deploys the master branch, and otherwise mentions master a lot)
[x] Update raw.githubusercontent.com URLs pointing to master of open-contracting repositories
[x] Update github.com/open-contracting URLs pointing to master across all repositories
[x] Go through each repository and fix miscellaneous occurrences
[x] Check that ReadTheDocs automatically builds the default branch (none of them explicitly set Default branch under Advanced Settings to "master" so this should work)
- I had to change the default branch, if it wasn't already main (like recent repositories like ocds-index)

It looks like the changes will not be difficult, just long.

Going through each repository:

[x] cove-oc4ids
[x] cove-ocds
[x] covid-19-procurement-explorer
[x] covid-19-procurement-explorer-admin
[x] data-registry
[x] deploy
[x] docson
[x] dqt
[x] dqv
[x] editor-tools
[x] european-union-support
[x] extension-explorer
[x] extension_registry
[x] extension_registry.py
[x] field-level-mapping-template
[x] glossary
[x] infrastructure
[x] jscc
[x] json-schema-random
[x] kingfisher-archive
[x] kingfisher-colab
[x] kingfisher-collect
[x] kingfisher-process
[x] kingfisher-summarize
[x] kingfisher-vagrant
[x] lib-cove-oc4ids
[x] lib-cove-ocds
[x] miscellaneous-private-scripts
[x] oc4ids_database
[x] ocds-babel
[x] ocds-extensions
[x] ocds-extensions-translations
[x] ocds-index
[x] ocds-merge
[x] ocdskit
[x] pelican
[x] sample-data
[x] sample-data-private
[x] software-development-handbook
[x] sphinxcontrib-opencontracting
[x] standard
[x] standard-development-handbook
[x] standard-maintenance-scripts
[x] standard_theme
[x] toucan

We serve extensions from GitHub at URLs that contain "master". According to https://github.blog/changelog/2020-07-17-links-to-deleted-branches-now-redirect-to-the-default-branch/, if we delete master and set main as default, these URLs will redirect. The initial estimate of the tasks to complete for open-contracting-extensions repositories was:

[ ] Add redirects from master to main in Extension Explorer
[ ] Rename extension resources in Transifex
[ ] Update raw.githubusercontent.com URLs pointing to master of open-contracting-extensions repositories
[ ] Go through each repository and fix miscellaneous occurrences

For the last item, having changed master to main for code repositories, there is a lot of code that assumes a default master branch for extensions. It will be too long and disruptive to change that. So, extensions and standard_extension_template will remain as master branch.

For profiles and standard_profile_template, we can change the default to latest:

[x] Change all default branches
[x] Add redirects from master to main for profiles, e.g. https://standard.open-contracting.org/profiles/eu/master/en/
[x] Update profiles to latest template
[x] Go through each repository and fix miscellaneous occurrences

jpmckinney commented 3 years ago

To do later, once consultants deliver the projects:

[x] covid-19-procurement-explorer-public
[x] kingfisher-process-django

jpmckinney commented 3 years ago

Some false positives in comments, content:

ColinMaudry commented 3 years ago

Is there something to do on client side (typically, the cloned repos on my laptop)?

ColinMaudry commented 3 years ago

Also, are the extension repositories going to be impacted? https://github.com/open-contracting-extensions

60 repos!

jpmckinney commented 3 years ago

Also, are the extension repositories going to be impacted? https://github.com/open-contracting-extensions

No, there is too much logic that depends on extension repos using "master" as the live branch, so they will not be changed. I updated this comment: https://github.com/open-contracting/standard-maintenance-scripts/issues/158#issuecomment-729805445

jpmckinney commented 3 years ago

Is there something to do on client side (typically, the cloned repos on my laptop)?

For standard, infrastructure, public-private-partnerships, extensions and standard_extension_template, they haven't changed.

For other repositories, GitHub shares instructions if you visit the repo's page. I'll share them below.

For european-union, government-procurement-agreement and standard_profile_template, the default branch is now latest. You must do:

git branch -m master latest
git fetch origin
git branch -u origin/latest latest

For all other repositories (code repositories), you must do:

git branch -m master main
git fetch origin
git branch -u origin/main main

open-contracting / standard-maintenance-scripts

Rename "master" branches to "main" #158