1 of 18

Branch Renaming Working Group Update

Collin Brittle �Chris Colvard �Jeremy Friesen �James Griffin�Kate Lynch �Lynette Rayle

2 of 18

Git branching

Default branch

Feature branch

Another feature branch

Image source: https://www.atlassian.com/git/tutorials/using-branches

3 of 18

Work in 2020

  • Formed in July 2020
    • Upholding the Community Code of Conduct, reflect our core values by eliminating coding jargon that perpetuates racist systems, language, and mentalities.
    • Rename the default branch of each repository with an appropriate, meaningful term, not “master”�
  • Initial findings and recommendations
    • Default branch name “main” recommended and accepted by the Community
    • Assessing areas of impact on shared workflows
    • Researched and recommended tools and scripts for updating the default branch name
    • Developed a plan to work with Component Maintenance Group to roll out changes

4 of 18

Work in 2020 - GitHub

​

5 of 18

Work in 2020 - GitHub

  • Our group:
    • Hiatus until December 2020 per announcement from GitHub�
    • Reconvene in December, review progress, determine next steps

6 of 18

Work in 2020 - GitHub

  • Our group:
    • Hiatus until December 2020 per announcement from GitHub�
    • Reconvene in December, review progress, determine next steps�
  • GitHub’s changes were in place by January 2021

7 of 18

How it works

8 of 18

How it works

9 of 18

How it works

10 of 18

GitHub: what is does

  • Default branch name “main” for new repositories�
  • Redirect open pull requests
  • Move branch protection rules
  • Redirect web requests for the old branch name
  • Return a "Moved Permanently" response in API requests
  • Instructions for updating local branch references
  • Displays a warning on the command line

11 of 18

GitHub: what it does

  • Default branch name “main” for new repositories�
  • Redirect open pull requests
  • Move branch protection rules
  • Redirect web requests for the old branch name
  • Return a "Moved Permanently" response in API requests
  • Instructions for updating local branch references
  • Displays a warning on the command line

12 of 18

GitHub: what it does

  • Default branch name “main” for new repositories�
  • Redirect open pull requests
  • Move branch protection rules
  • Redirect web requests for the old branch name
  • Return a "Moved Permanently" response in API requests
  • Instructions for updating local branch references
  • Displays a warning on the command line

13 of 18

GitHub: what it doesn’t do

  • Does not prevent creation of a branch called “master”
    • This breaks much of the forwarding functionality�
  • Can override default branch name in user settings

14 of 18

Samvera: What we can do

  • CircleCI test to error on presence of “master” branch�
  • CONTRIBUTING language

15 of 18

Samvera: What we can do

  • CircleCI test to error on presence of “master” branch�
  • CONTRIBUTING language

16 of 18

Next steps

  • Revise recommendation�
  • Implement communication plan, begin making changes to Samvera and �Samvera-labs repos �
  • Report out to the community
  • Provide further recommendations

17 of 18

Our Tools and Documentation

​

18 of 18

Thank you!