r-lib / downlit

Syntax Highlighting and Automatic Linking
https://downlit.r-lib.org
Other
90 stars 22 forks source link

Move `master` branch to `main` #109

Closed jennybc closed 3 years ago

jennybc commented 3 years ago

The master branch of this repository will soon be renamed to main, as part of a coordinated change across several GitHub organizations (including, but not limited to: tidyverse, r-lib, tidymodels, and sol-eng). We anticipate this will happen by the end of September 2021.

That will be preceded by a release of the usethis package, which will gain some functionality around detecting and adapting to a renamed default branch. There will also be a blog post at the time of this master --> main change.

The purpose of this issue is to:

message id: euphoric_snowdog

jennybc commented 3 years ago

I have moved the default branch from master to main here (and elsewhere)!

When I ran usethis::git_default_branch_rename(), I saw this output, which might require some follow-up:

✓ Default branch of the source repo 'r-lib/downlit' has moved: 'master' --> 'main'
• Be sure to update files that refer to the default branch by name.
  Consider searching within your project for 'master'.
x These GitHub Action files don't mention the new default branch 'main':
  - '.github/workflows/pandoc.yml'
  - '.github/workflows/pkgdown.yaml'
  - '.github/workflows/R-CMD-check.yaml'
  - '.github/workflows/test-coverage.yaml'
x Some badges may refer to the old default branch 'master':
  - 'README.md'
✓ Default branch of local repo has moved: 'master' --> 'main'

As a result, I won't close this issue, but rest assured that the default branch has been renamed.

This blog post announces the larger effort and explains how contributors can update their local environments:

Renaming the default branch

Here's the TL;DR:

  1. Update usethis (you want usethis v2.1.2 or higher):
    install.packages("usethis")
  2. Anyone with an existing fork or clone can adjust to the renamed default branch with:
    usethis::git_default_branch_rediscover()

    If you wish, you can read the documentation for git_default_branch_rediscover(). Or do the command line equivalent (see the blog post).

message id: goofy_chipmunk

hadley commented 3 years ago

Looks like the workflows were a false positive.

jennybc commented 3 years ago

I looked into the false positives. It's because, when I ran git_default_branch_rename(), I didn't necessarily pull first (because I thought that would cause more pain than happiness when walking over 200 repos). So if it wasn't a fresh clone, and I was behind master, I could be analyzing old GHA configs, which apparently I was here.