The Github branch rename has been completed.  Actions developers should take:

  1.  Update your Github fork: rename "master" to "main".  Failure to do this 
will likely lead to wailing and gnashing of teeth at some point.
     *   Navigate to your Github fork --> Settings --> Branches (e.g.,
     *   Click on the pencil button to the right of the default "master" branch.
     *   Change "main" to "master" and click "Rename branch".

  2.  Update your local Git clones of the OMPI tree: for example:

git branch --move master main
git fetch origin
git branch --set-upstream-to origin/main main
git remote set-head origin -a

  3.  Update your MTT config:
     *   The simplest thing to do is to s/master/main/g in all your MTT config 
     *   The old "master" nightly snapshot download URL will work for the next 
7 days (it will stop working Friday, 1 April 2022), where "work" means:
        *   The URL will exist and HTTP GETs will not generate 404s
        *   No new tarballs will be updated

Stuff developers probably want to know:

  1.  All pull requests in that targeted 
"master" have been automatically re-targeted to "main"
     *   There was one exception (PR #3262).  The owner of that PR was notified.
  2.  The first snapshot tarball from the "main" branch has been created:

Please let us know if you have any questions or problems.

Jeff Squyres

From: Jeff Squyres (jsquyres) <>
Sent: Friday, March 25, 2022 10:46 AM
To: Open MPI Developers
Subject: Re: Renaming Open MPI's git "master" branch

Gentle reminder that Brian and I will start this change in about 15 minutes.

Jeff Squyres

From: Jeff Squyres (jsquyres) <>
Sent: Tuesday, March 22, 2022 12:30 PM
To: Open MPI Developers
Subject: Re: Renaming Open MPI's git "master" branch

This was discussed both off-list and on the weekly Open MPI dev call.  Here's 
the points that were discussed, in no particular order:

  *   We definitely need to give a heads-up to build-from-source projects like 
Spack and EasyBuild.
     *   It's not common, but it is possible to build Open MPI's master branch 
from Spack / EasyBuild.  Hence, we should notify these communities to update 
the git branch name from "master" to "main".
     *   Howard offered to open a Spack PR to update this.
     *   We'll also ping Kenneth from EasyBuild.
     *   There was some concern that we should give such communities a little 
time to adjust to the new name.  After some discussion, the consensus is that 
this is likely not necessary a) because it's not common for these tools to 
build from master, and b) it should be a quick/easy fix for them to update the 
branch name.  Let's just get it done.
  *   "git symbolic-ref refs/head/master refs/head/main" may be helpful for 
developers to transition themselves to the new name locally.
  *   When a branch is renamed at GitHub, some degree of automatic renaming 
will occur (e.g., surfing to will automatically get 
HTTP redirected).
     *   See for details about what does -- 
and does not -- happen.
  *   There were some questions as to whether "main" is a good choice of branch 
name.  There's been a bunch of debate about this over the past year.
     *   Git 2.35.1 (the most recent) version still defaults to "master".
     * defaults to "main".
     *   Other names like "dev" and "devel" were also proposed for Open MPI.
     *   My $0.02: Github defaults to "main", and that effectively represents 
what many people use.  Let's just go with that.
  *   The "ompi" repo is the first one to get this branch name change.
     *   This change is mainly being driven by the Open MPI's ReadTheDocs 
initiative that publishes docs by branch name -- we didn't want with URLs 
containing "/master/" getting bookmarked, linked to, ... etc.  Meaning: we have 
to change the name now, before v5.0.0 is released, and the new RTD OMPI docs 
web site goes mainstream.
     *   We will eventually also update the other Open MPI git repos for master 
--> main, but those should likely be less painful.  Stay tuned for further info.

Unless we hear any major objections, Brian and I will be making this change 
this upcoming Friday, 25 March, 2022, from 11am-1pm US Eastern time.  In 
general, the changes will be:

  *   Rename the master branch at github.
     *   Delete the "master" branch out of our personal forks (this is STRONGLY 
advised for everyone else, too!)
  *   Update / rename nightly snapshot tarballs.
  *   Update our MTT configurations to match the new nightly snapshot tarball 
name / location.
  *   Update to build the new branch and remove the old branch
     *   Update any internal docs references to "master" on main, v5.0.x, 
v4.0.x, v4.1.x
  *   Update any references to "master" on
  *   Ask Howard to make his Spack PR
  *   Notify the EasyBuild community
  *   Email this devel list to confirm that it's all done.

For MTT, we will hopefully be able to leave the old "master" S3 folder around 
for a week or two.  This will give people time to update their MTT configs.  
There will definitely be an EOL date on that folder, however -- we're not going 
to maintain the old name for very long.

In general, we don't plan to support many behind-the-scenes master --> main 
remappings to allow people to continue to use the old "master" name.  We'd 
rather people actually updated to the new name.

Please let me know if you have any questions, suggestions, or concerns.  Thanks!

Jeff Squyres

From: Jeff Squyres (jsquyres)
Sent: Friday, March 18, 2022 11:29 AM
To: Open MPI Developers
Subject: Renaming Open MPI's git "master" branch

This is a bit overdue, but we're finally getting to this.

We are planning to rename Open MPI's git "master" branch to "main" one week 
from today: Friday, 25 Mar, 2022.

Brian and I will handle most of the logistics of this change, but there will 
likely be a little disruption for developers.  For example, next Friday, I 
would strongly suggest deleting the "master" branch out of your fork so that 
your fingers don't accidentally type "git checkout master" and you end up on 
some very-outdated git reference.

We'll send out more information soon, but wanted to give everyone a heads-up 
that this is coming, and to prepare for a little disruption.

Jeff Squyres

Reply via email to