Do foundational work to support to support gitlab-org/gitlab default branch
Overview
gitlab-com/gl-infra/delivery#1357 (closed) plans to rename gitlab-org/gitlab
default branch from master
to main
, the timeline is still in the works (it might happen during the first quarter of 2021) but when it happens we should be prepared.
Let's use this issue to discuss what needs to be done on GitLab Pages before the switch.
Proposal
I'm not certain this project depends on a hardcoded master
branch for gitlab-org/gitlab
. From a quick search, seems it only references master
on the docs, which makes me think this project is detached from gitlab-org/gitlab
and does not depend on a hardcoded master
branch.
List of files that reference `master` branch for `gitlab-org/gitlab`
./PROCESS.md:20:[development month](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md),
./PROCESS.md:27:Typically, release tags point to a specific commit on the **master** branch. As
./PROCESS.md:32:A bug fix may required in a particular version after the **master** branch has
./PROCESS.md:40:In either case, the fix should first be developed against the master branch.
./PROCESS.md:41:Once ready, the fix should be merged to master, where it will be
./PROCESS.md:58: - Merge request targeting `master` is prepared with the GitLab Pages security fix.
./PROCESS.md:68: - Merge the merge requests targeting `master`.
./.gitlab/ci/prepare.yml:16: # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
./.gitlab/issue_templates/release.md:8: git --no-pager log --merges --pretty=oneline master...vX.Y.Z
./.gitlab/issue_templates/release.md:11: the [Versioning](https://gitlab.com/gitlab-org/gitlab-pages/blob/master/PROCESS.md#versioning)
./.gitlab/issue_templates/release.md:12: * Typically if you want to release code from current `master` branch you will update `MINOR` version, e.g. `1.12.0` -> `1.13.0`. In that case you **don't** need to create stable branch
./.gitlab/issue_templates/release.md:20: In case of `master` branch:
./.gitlab/issue_templates/release.md:22: git fetch origin master
./.gitlab/issue_templates/release.md:23: git fetch dev master
./.gitlab/issue_templates/release.md:24: git tag -a -s -m "Release v1.0.0" v1.0.0 origin/master
./.gitlab/issue_templates/release.md:37: * ```(tag: v1.0.0, origin/master, dev/master, master)``` for `master`
./internal/source/domains.go:160:// https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/serverless/domain.rb#L7
./README.md:3:[![build status](https://gitlab.com/gitlab-org/gitlab-pages/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/gitlab-pages/commits/master)
./README.md:4:[![coverage report](https://gitlab.com/gitlab-org/gitlab-pages/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/gitlab-pages/commits/master)
./CONTRIBUTING.md:10:[DCO + License](https://gitlab.com/gitlab-org/dco/blob/master/README.md)
./CONTRIBUTING.md:66:operates please see [the GitLab contributing process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md).
./CONTRIBUTING.md:341:[update the notes]: https://gitlab.com/gitlab-org/release-tools/blob/master/doc/pro-tips.md#update-the-regression-issue
./CONTRIBUTING.md:416:1. Create a feature branch, branch away from `master`
./CONTRIBUTING.md:423:1. Submit a merge request (MR) to the `master` branch
./CONTRIBUTING.md:453:The ['How to get faster PR reviews' document of Kubernetes](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md) also has some great points regarding this.
./CONTRIBUTING.md:476: only one working on your feature branch, otherwise, merge `master`)
./CONTRIBUTING.md:520:1. Upgrade guide, for example https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/update/7.5-to-7.6.md
./CONTRIBUTING.md:521:1. Upgrader https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/update/upgrader.md#2-run-gitlab-upgrade-tool
./CONTRIBUTING.md:522:1. Installation guide https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md#1-packages-dependencies
./CONTRIBUTING.md:524:1. Test suite https://gitlab.com/gitlab-org/gitlab-ce/blob/master/scripts/prepare_build.sh
./doc/development.md:3:If you want to develop GitLab Pages with the GDK, follow [these instructions](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/pages.md).
./.gitlab-ci.yml:9: # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
What we could do is:
- Identify what areas of the GitLab Pages codebase depend on a hardcoded
master
branch forgitlab-org/gitlab
- Adjust the corresponding files (if any)