Skip to content

Evaluate master/main usage and resolve issues - Create

Problem to solve

In the upcoming 14.0 release, GitLab will be moving both user's default branches and its own default branch use for repos from master to main. The term master can be found throughout our documentation, in narratives, code examples, and in URL links to items in our repos. By the time of the 14.0 release, these instances need to be identified and fixed to instead refer to main (or when used in a narrative sense in lines of content, we can also use the "the default branch" without mentioning a specific name).

Proposal

Review your groups' documentation identify usage of master and replace them as needed with either main or "the default branch" as necessary. Note that we cannot change code samples or URL links until the 14.0 release, when the change will be made to our repositories.

The following steps can help to identify items:

  1. Edit the doc/.vale/gitlab/DefaultBranch.yml rule and change warning to error.
  2. Edit the doc/.vale/gitlab/InclusionCultural.yml rule and change warning to error.
  3. Modify this command to match the stage or group you're working on:
    • stage-specific: grep -riI --files-with-match "stage: stagename" . | xargs vale --no-wrap --minAlertLevel error
    • group-specific: grep -riI --files-with-match "group: groupname" . | xargs vale --no-wrap --minAlertLevel error

Important: InclusionCultural.yml tests for more words than just master, but the scope of the work here is limited to the word master. Don't worry about any other words identified by the test, and also don't worry about any instances of master that aren't related to Git and GitLab repos.

The deliverable is one or more linked MRs that resolve the issue, noting that overall work won't be completed until the 14.0 milestone.

(If your groups' docs don't include any references to master, please note that in a comment and close the issue.

Other links/references