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

Suggestion: Rename default branch to "main" #1357

Closed
aaaaalbert opened this issue Dec 8, 2023 · 9 comments
Closed

Suggestion: Rename default branch to "main" #1357

aaaaalbert opened this issue Dec 8, 2023 · 9 comments
Assignees
@renchap
Labels
chore Background admin work for the repo

Comments

@aaaaalbert
Copy link
Contributor

Mastodon renamed its default branch to "main" a while ago. This follows a general trend whose background and rationale is explained, e.g., in this GitHub write-up.

I suggest to do the same for the documentation repo. The GitHub document linked above even contains a guide on how to do that.
@andypiper
Copy link
Sponsor Member

Accepted, we should do this - we did this on the joinmastodon repo recently. We just need to ensure that changing the branch name does not affect the documentation auto deployment at the same time. Looking into this.

@andypiper
Copy link
Sponsor Member

@renchap I believe this requires .github/workflows/deploy.yml modified to target main. Do you have any other concerns or notes on such a change? Would be great to align with our other repositories.

@aaaaalbert
Copy link
Contributor Author

Side note: Same goes for this Gitlab CI file. Also, some files in layouts/ mention master in URLs (1, 2, 3).

I can send a PR for all of that (if it can wait until the end of the week or so.)

@andypiper
Copy link
Sponsor Member

I don’t think we use the Gitlab CI any more but I could be mistaken. Thanks for spotting the other instances of the branch name - we would definitely want to do those as well. Happy to review a PR later!

@renchap
Copy link
Sponsor Member

renchap commented Dec 12, 2023

We do not rely on Gitlab CI anymore, this can be dropped.

I am all for switching to main, and I can do it once there is a PR ready with the changes you mentioned above.

@aaaaalbert
Copy link
Contributor Author

Thanks for the clarification!

@andypiper andypiper added the chore Background admin work for the repo label Dec 12, 2023
aaaaalbert pushed a commit to aaaaalbert/documentation that referenced this issue Dec 15, 2023
Remove GitLab CI configuration
b23d5a4 
As noted by @renchap, "We do not rely on Gitlab CI anymore, this
can be dropped."

mastodon#1357 (comment)
aaaaalbert pushed a commit to aaaaalbert/documentation that referenced this issue Dec 15, 2023
Fix mastodon#1357, Use new default branch name "main"
3bd8ce9 
This requires changes in
* the GitHub Pages deployment config
* a few HTML page templates, where the default branch name is
  included in links to the repo (stylized as "Improve this page"
  in the English version of the live docs webpage)
@aaaaalbert aaaaalbert mentioned this issue Dec 15, 2023
Merged
@aaaaalbert
Copy link
Contributor Author

Here we go: PR #1373

@renchap renchap closed this as completed in 5222920 Jan 2, 2024
@renchap
Copy link
Sponsor Member

renchap commented Jan 2, 2024

Thanks for the PR.

I renamed the branch, merged your PR, and fixed the Github Pages setup. Everything seems to be working on my end!

@aaaaalbert
Copy link
Contributor Author

Great, my pleasure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@renchap renchap

Labels
chore Background admin work for the repo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@renchap @andypiper @aaaaalbert