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.

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

Maintenance: Move main branch to "main" #2840

Closed
pljones opened this issue Sep 6, 2022 · 21 comments
Closed

Maintenance: Move main branch to "main" #2840

pljones opened this issue Sep 6, 2022 · 21 comments
Assignees
Labels
refactoring Non-behavioural changes, Code cleanup tooling Changes to the automated build system

Comments

@pljones
Copy link
Collaborator

pljones commented Sep 6, 2022

Change

Update github and any automation, plus documentation and Weblate to show the project main branch is named "main".

Reason

To remove sensitive references.

@pljones pljones added refactoring Non-behavioural changes, Code cleanup needs documentation PRs requiring documentation changes or additions labels Sep 6, 2022
@pljones pljones added this to the Release 3.10.0 milestone Sep 6, 2022
@jamulussoftware jamulussoftware locked and limited conversation to collaborators Sep 6, 2022
@ann0see
Copy link
Member

ann0see commented Dec 25, 2022

@pljones any updates on this?
As there isn't much happening at the moment, I think it's good to

  1. Create a main branch
  2. Search for occurrences of "master" in the docs
  3. Replace all these occurrences with "main"
  4. Change the target branch of all open PRs to "main"
  5. Set the default branch to "main" on GitHub
  6. Add a warning message to the README.md file on the old master branch - better replace it fully and remove the content of master
  7. Wait some time to let the build of dependent distros/scripts fail
  8. Remove the master branch fully

Related: https://www.r-bloggers.com/2020/07/5-steps-to-change-github-default-branch-from-master-to-main/

@pljones
Copy link
Collaborator Author

pljones commented Dec 26, 2022

I've a lot happening, currently, so if anyone wants to pick the issue up, feel free.

@ann0see
Copy link
Member

ann0see commented Dec 26, 2022

Master branch is now deprecated.

@ann0see
Copy link
Member

ann0see commented Dec 26, 2022

The website has been updated too.

@hoffie
Copy link
Member

hoffie commented Dec 26, 2022

Maybe also post a Discussion announcement (targeted at developers)?

@ann0see
Copy link
Member

ann0see commented Dec 26, 2022

Yes. Maybe with a link to what needs to be changed locally (git commands).

@pljones
Copy link
Collaborator Author

pljones commented Dec 26, 2022

Thanks - maybe summarise here what changes were done.

@ann0see
Copy link
Member

ann0see commented Dec 27, 2022

  • Created a new branch called main based on master branch
  • Changed Jamulus.pro on master such that qmake returns an error saying that the user compiles from the wrong branch
  • Added a note to README.md on master saying that this is the wrong branch
  • Used Atom search and replace to replace all ocurrances of master by main in the source files and committed this to main (this failed at first, but I fixed it with a force push)
  • Changed the main repo default branch on GitHub to main
  • Changed the target branch of all open PRs to main
  • Changed the source branch on weblate to main
  • Changed ocurrances of master to main on jamuluswebsite release branch and resolved conflicts
  • Opened a discussion on the forum to explain the change

Hopefully I didn't miss anything.

@ann0see
Copy link
Member

ann0see commented Dec 27, 2022

Todo: Decide on when to remove the master branch fully.

@ann0see
Copy link
Member

ann0see commented Feb 12, 2023

I've now removed even more files on the old master branch to make the error more obvious. I think a few weeks after the next release, we should get rid of the master branch fully.

@pljones
Copy link
Collaborator Author

pljones commented Apr 19, 2023

@ann0see do you want to leave this until after 3.10.0 is cut or can it complete now?

@ann0see
Copy link
Member

ann0see commented Apr 19, 2023

I'd like to remove it shortly after the release is out. Some people might pull at that time and then it's better to get a human readable error rather than some strange git error.

@ann0see
Copy link
Member

ann0see commented Apr 19, 2023

I've now added an actionable link to the pinned discussion: https://github.com/jamulussoftware/jamulus/blob/master/README.md

@pljones pljones added the tooling Changes to the automated build system label May 21, 2023
@pljones
Copy link
Collaborator Author

pljones commented May 31, 2023

Moved to "Waiting Externally" as "time" is ... um ... external, right?

@ann0see
Copy link
Member

ann0see commented May 31, 2023

You could argue that. Yes.

@ann0see
Copy link
Member

ann0see commented Jul 28, 2023

Added a ChangeLog entry for this one. See #3093. Dropped needs documentation.

@ann0see ann0see removed the needs documentation PRs requiring documentation changes or additions label Jul 28, 2023
@pljones
Copy link
Collaborator Author

pljones commented Jul 29, 2023

dd01e00 is related.

@pljones
Copy link
Collaborator Author

pljones commented Jul 30, 2023

https://github.com/orgs/jamulussoftware/discussions/2984

To raise awareness without a cryptic git error message and allow a smoother transition, the master branch still exists for a few weeks but compilation from master instead of main will fail.

Is that still valid? I thought the branch had now gone?

@ann0see
Copy link
Member

ann0see commented Jul 30, 2023

No. The branch should be deleted shortly after the release as there might be people cloning from master.

@ann0see
Copy link
Member

ann0see commented Sep 5, 2023

I think that we should delete the old branch after the coming weekend.

@ann0see
Copy link
Member

ann0see commented Sep 10, 2023

Ok. Master branch is now gone.

@ann0see ann0see closed this as completed Sep 10, 2023
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
refactoring Non-behavioural changes, Code cleanup tooling Changes to the automated build system
Projects
Status: Done
Development

No branches or pull requests

3 participants