Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename ITK repository default branch from master to main #4732

Open
3 of 15 tasks
thewtex opened this issue Jun 19, 2024 · 5 comments
Open
3 of 15 tasks

Rename ITK repository default branch from master to main #4732

thewtex opened this issue Jun 19, 2024 · 5 comments
Labels
type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Milestone
ITK 6.0.0

Comments

@thewtex
Copy link
Member

thewtex commented Jun 19, 2024 •
edited by jhlegarreta
Loading

Description

main is now the default branch for GitHub projects as opposed to master. Provide the expected default.

Impact analysis

This will provide the expected default branch name, and it will also cause disruption to existing clones and forks.

Versions

Target for ITK 6.

Additional Information

Todo:

  • Update related repositories
    • Update remote module's default branches (in progress)
    • Update ITKSphinxExamples
    • Update ITKSoftwareGuide
    • Update ITK-Wasm
    • Update itk-viewer
  • Community notices (Discourse, etc.)
  • https://adamj.eu/tech/2022/10/27/git-how-to-alias-master-as-main/
  • Dashboard Scripts
  • Scripts in the repository
  • Release scripts
  • Dashboard systems
  • Setup nightly sync of master backwards compatibility branch to main
  • Add to documentation how to update local clone configuration and GitHub forks
  • GitHub Repository Settings Rename master default branch to main

@hjmjohnson
@thewtex thewtex added the type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots label Jun 19, 2024
@github-actions GitHub Actions
Copy link

Thank you for contributing an issue! 🙏

Welcome to the ITK community! 🤗👋☀️

We are glad you are here and appreciate your contribution. Please keep in mind our community participation guidelines. 📜
Also, please check existing open issues and consider discussion on the ITK Discourse. 📖

This is an automatic message. Allow for time for the ITK community to be able to read the issue and comment on it.

@thewtex thewtex added this to the ITK 6.0.0 milestone Jun 19, 2024
@dzenanz
Copy link
Member

dzenanz commented Jun 19, 2024

Welcome to the ITK community Matt 😄

@thewtex thewtex changed the title Rename the ITK repository default from master to main Rename ITK repository default branch from master to main Jun 20, 2024
@jhlegarreta
Copy link
Member

All remotes having a LICENSE badge will surely have the default branch name hard-coded, e.g.
https://github.com/InsightSoftwareConsortium/ITKIOTransformDCMTK/blob/master/LICENSE

https://github.com/InsightSoftwareConsortium/ITKIOTransformDCMTK/pull/14/files#diff-7b3ed02bc73dc06b7db906cf97aa91dec2b2eb21f2d92bc5caa761df5bbc168fR9

So after the default branch gets renamed to main these links will no longer work. Having an easy way to apply changes to all remotes with a single command for this kind of changes is becoming a must, otherwise maintaining them is very time-consuming.

@thewtex
Copy link
Member Author

thewtex commented Sep 9, 2024

I have started to rename the remote repository branches to main in the process of #4748 . We can use the all-repos tool to update the README badges.

@jhlegarreta
Copy link
Member

Have renamed the default branch in ITKSoftwareGuide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
Milestone
ITK 6.0.0
Development

No branches or pull requests
3 participants
@thewtex @dzenanz @jhlegarreta