Include Page |
---|
| Deliverables (navigation) - Samvera Branch Renaming Working Group |
---|
| Deliverables (navigation) - Samvera Branch Renaming Working Group |
---|
|
Summary of Observations
- Renaming in GitHub does not change localhost, links to master from wiki pages, issues, or PR comments.
- Renaming in GitHub does change branch name, branch settings, PR base branch.
- Renaming a branch other than master that is in a PR waiting to merge into another branch, closes the PR.
- Once renamed, instructions are provided for renaming at localhost. Once those are cleared, I couldn't find a way to get them back. I tried renaming another branch, but they still were not shown again.
- Once master is renamed, a user can push master to the repo again. There were no settings in Settings → Branches → add rule, that would prevent the master branch from being created again in the repo.
Setup
- Create a test repo with a master branch, issues, PRs - See samvera-labs/branch-renaming-wg for a script to do this. This script sets up conditions in the test repo:
- Default branch is master
- add branch settings for master branch under Settings → Branches
- Conditions to set up manually:
- Within the test repo, create a wiki page that references a branch in master. -- link in Home page accessed from Wiki in header menu
- Create a Fork of the test repo. -- samvera-labs/branch-renaming-test-1
- Clone the test repo to your local machine.
- Clone the Fork to your local machine.
- Create a second repo with a pin in the Gemfile to a master sha in the repo having the branch renamed -- N/A The test app is not setup as a gem.
Tool: gitHub-default-branch
...
- renames master to main
- branch dropdown defaults to main
- master is not in the branch dropdown
- Settings → Branches
- main is the default branch
- branch rules were copied over to main
- master branch is not in the branch dropdown under Default branch
- master branch is not listed in the Branch protection rules area
- updates issues
- changes reference to a sha in master to the same sha in main
- changes links to code in master branch to the same code in main -- NO -- (NOTE: Even though the link text and URL were not changed, GitHub forwards to the renamed branch which is
main
.)
- updates PRs
- updates 'commit into' branch to main for all PRs
- updates links to code in master branch to the same code in main -- NO -- (NOTE: Even though the link text and URL were not changed, GitHub forwards to the renamed branch which is
main
.)
- documentation
- in wiki page, updates links to code in master branch to the same code in main -- NO -- (NOTE: Even though the link text and URL were not changed, GitHub forwards to the renamed branch which is
main
.) - in README, updates links to code in master branch to the same code in main -- NO -- (NOTE: Even though the link text and URL were not changed, GitHub forwards to the renamed branch which is
main
.)
- local git repo
- commit/push without changing branch name locally automatically DOES NOT recreate the old branch name -- NO -- IT DOES recreate master
- commit/push without changing branch name locally automatically goes to new branch name -- NO -- IT GOES to master branch
- AND all links directed at master no longer autoforward to main; they go to master branch
- updates local master tracking origin/master to local main tracking origin/main -- NO -- nothing locally automatically updates
- after following instructions for updating local git repo
- updates branches based on origin/master to origin/main
- updates branches based on local master to local main
- in second repo, updates pin to master sha in the repo having the branch renamed (NOT TESTED)
- working with Forks
Rename non-master branch:
...