master to main branch migration (#1527)

maxnbk · web-flow · commit 5fd85d21b0ef · 2023-09-14T18:54:54.000-04:00
Signed-off-by: Stephen Mackenzie &lt;maxnbk@users.noreply.github.com&gt;
diff --git a/.github/workflows/benchmark.yaml b/.github/workflows/benchmark.yaml
@@ -93,11 +93,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
         with:
-          ref: master
+          ref: main
           path: src
 
           # This is a PAT from an Admin user. We do this in order to be able to write to a
-          # protected branch (master) from this workflow.
+          # protected branch (main) from this workflow.
           # See https://github.community/t/how-to-push-to-protected-branches-in-a-github-action/16101/14
           #
           token: "${{ secrets.GH_ACTION_TOKEN }}"
@@ -134,6 +134,6 @@ jobs:
           else
             git add --all
             git commit -m "Generated from GitHub "${{ github.workflow }}" Workflow"
-            git push origin master
+            git push origin main
           fi
         working-directory: src
diff --git a/.github/workflows/wiki.yaml b/.github/workflows/wiki.yaml
@@ -59,5 +59,5 @@ jobs:
         run: |
           git add --all
           ( git commit -m "Generated from GitHub ${{ github.workflow }} Workflow" \
-            && git push origin master \
+            && git push origin main \
           ) || echo "Nothing new to commit"
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 [![Release](https://shields.io/github/v/release/AcademySoftwareFoundation/rez)](https://github.com/AcademySoftwareFoundation/rez/releases)
 [![Pypy Release](https://shields.io/pypi/v/rez)](https://pypi.org/project/rez)<br>
-[![Core](https://github.com/AcademySoftwareFoundation/rez/workflows/core/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Acore+branch%3Amaster)
-[![Ubuntu](https://github.com/AcademySoftwareFoundation/rez/workflows/ubuntu/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Aubuntu+branch%3Amaster)
-[![Mac](https://github.com/AcademySoftwareFoundation/rez/workflows/mac/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Amac+branch%3Amaster)
-[![Windows](https://github.com/AcademySoftwareFoundation/rez/workflows/windows/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3AWindows+branch%3Amaster)<br>
-[![Installation](https://github.com/AcademySoftwareFoundation/rez/workflows/installation/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Ainstallation+branch%3Amaster)
-[![Flake8](https://github.com/AcademySoftwareFoundation/rez/workflows/flake8/badge.svg?branch=master)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Aflake8+branch%3Amaster)
+[![Core](https://github.com/AcademySoftwareFoundation/rez/workflows/core/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Acore+branch%3Amain)
+[![Ubuntu](https://github.com/AcademySoftwareFoundation/rez/workflows/ubuntu/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Aubuntu+branch%3Amain)
+[![Mac](https://github.com/AcademySoftwareFoundation/rez/workflows/mac/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Amac+branch%3Amain)
+[![Windows](https://github.com/AcademySoftwareFoundation/rez/workflows/windows/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3AWindows+branch%3Amain)<br>
+[![Installation](https://github.com/AcademySoftwareFoundation/rez/workflows/installation/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Ainstallation+branch%3Amain)
+[![Flake8](https://github.com/AcademySoftwareFoundation/rez/workflows/flake8/badge.svg?branch=main)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Aflake8+branch%3Amain)
 [![Wiki](https://github.com/AcademySoftwareFoundation/rez/workflows/wiki/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Awiki+event%3Arelease)
 [![Pypi](https://github.com/AcademySoftwareFoundation/rez/workflows/pypi/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Apypi+event%3Arelease)
 [![Benchmark](https://github.com/AcademySoftwareFoundation/rez/workflows/benchmark/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Abenchmark+event%3Arelease)<br>
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,11 +1,11 @@
 # Releasing New Rez Versions
 
-To merge a PR to master and release a new version:
+To merge a PR to the `main` branch and release a new version:
 
 1. Merge the PR locally, following the instructions given on GitHub in the
-   `command line instructions` link (but do not push to master yet);
+   `command line instructions` link (but do not push to `main` yet);
 2. Run the tests (rez-selftest) to double check nothing is broken;
-3. Make sure the [rez version](https://github.com/AcademySoftwareFoundation/rez/blob/master/src/rez/utils/_version.py)
+3. Make sure the [rez version](https://github.com/AcademySoftwareFoundation/rez/blob/main/src/rez/utils/_version.py)
    is correct, and change if necessary. The version may have been correct at the
    time of PR submission, but may need an update due to releases that have occurred
    since;
@@ -17,10 +17,10 @@ To merge a PR to master and release a new version:
    ```
    This command prints the changelog entry to stdout, which you can then paste in
    to the top of CHANGELOG.md.
-5. Commit and push to master;
+5. Commit and push to `main`;
 6. Wait for all Github workflows to pass;
 7. Run the release-rez utility script. This performs the following actions:
-   * Creates tag on latest version, and pushes tag to master;
+   * Creates tag on latest version, and pushes tag to `main`;
    * Generates the new GitHub release (https://github.com/AcademySoftwareFoundation/rez/releases).
    ```
    ]$ python ./release-rez.py
diff --git a/release-rez.py b/release-rez.py
@@ -107,11 +107,11 @@ def parse_topmost_changelog():
     assert False
 
 
-def check_on_master():
+def check_on_main():
     branch = run_command("git", "branch", "--contains").split()[-1]
 
-    if branch != "master":
-        sys.stderr.write("Must be run from master.\n")
+    if branch != "main":
+        sys.stderr.write("Must be run from the 'main' branch.\n")
         sys.exit(1)
 
 
@@ -269,7 +269,7 @@ def generate_changelog_entry(issue_nums):
     def doit(step):
         return (opts.step is None) or (step == opts.step)
 
-    check_on_master()
+    check_on_main()
 
     if doit("push"):
         push_codebase()
diff --git a/src/rez/config.py b/src/rez/config.py
@@ -35,7 +35,7 @@
 class Setting(object):
     """Setting subclasses implement lazy setting validators.
 
-    Note that lazy setting validation only happens on master configuration
+    Note that lazy setting validation only happens on main configuration
     settings - plugin settings are validated on load only.
     """
     schema = Schema(object)
@@ -497,8 +497,8 @@ class Config(six.with_metaclass(LazyAttributeMeta, object)):
     `Config` object directly.
 
     Config files are merged with other config files to create a `Config`
-    instance. The 'rezconfig' file in rez acts as the master - other config
-    files update the master configuration to create the final config. See the
+    instance. The 'rezconfig' file in rez acts as the primary - other config
+    files update the primary configuration to create the final config. See the
     comments at the top of 'rezconfig' for more details.
     """
     schema = config_schema
diff --git a/src/rez/rezconfig.py b/src/rez/rezconfig.py
@@ -1206,7 +1206,7 @@
         # can be used to block releases from development or feature branches,
         # and support a workflow such as "gitflow".  Each branch name should be
         # a regular expression that can be used with re.match(), for example
-        # "^master$".
+        # "^main$".
         "releasable_branches": [],
 
         # If True, a release will be cancelled if the repository has already been
diff --git a/src/rezplugins/build_system/template_files/Doxyfile b/src/rezplugins/build_system/template_files/Doxyfile
@@ -1018,7 +1018,7 @@ HHC_LOCATION           =
 
 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
 # controls if a separate .chi index file is generated (YES) or that
-# it should be included in the master .chm file (NO).
+# it should be included in the main .chm file (NO).
 
 GENERATE_CHI           = NO
 
diff --git a/wiki/generate-wiki.py b/wiki/generate-wiki.py
@@ -29,7 +29,7 @@
 
 OUT_DIR = "out"
 GITHUB_REPO = "unknown/rez"
-GITHUB_BRANCH = "master"
+GITHUB_BRANCH = "main"
 GITHUB_WORKFLOW = "Wiki"
 
 
diff --git a/wiki/pages/Basic-Concepts.md b/wiki/pages/Basic-Concepts.md
@@ -359,7 +359,7 @@ The digram shows the following operations occurring:
 * This results in a list of resolved packages. These are the packages that are used in the
   configured environment;
 * The commands from each package are concatenated together;
-* This master list of commands is then translated into the target shell language (in this example
+* This total list of commands is then translated into the target shell language (in this example
   that is *bash*);
 * A sub-shell is created and the translated command code is sourced within this environment,
   creating the final configured environment.
diff --git a/wiki/pages/Configuring-Rez.md b/wiki/pages/Configuring-Rez.md
@@ -112,7 +112,7 @@ Here is an example showing how to override settings using your own configuration
 Following is an alphabetical list of rez settings.
 
 > [[media/icons/info.png]] Note that this list has been generated automatically
-> from the [rez-config.py](https://github.com/__GITHUB_REPO__/blob/master/src/rez/rezconfig.py)
+> from the [rez-config.py](https://github.com/__GITHUB_REPO__/blob/main/src/rez/rezconfig.py)
 > file in the rez source, so you can also refer to that file for the same information.
 
 __REZCONFIG_MD__
diff --git a/wiki/pages/Package-Definition-Guide.md b/wiki/pages/Package-Definition-Guide.md
@@ -900,11 +900,11 @@ setting 'TODO_ADD_THIS'). A package may not have a release message.
 *Type varies*
 
     revision = \
-        {'branch': 'master',
+        {'branch': 'main',
          'commit': '22abe31541ceebced8d4e209e3f6c44d8d0bea1c',
          'fetch_url': 'git@github.com:foo/dummy.git',
          'push_url': 'git@github.com:foo/dummy.git',
-         'tracking_branch': 'origin/master'}
+         'tracking_branch': 'origin/main'}
 
 Information about the source control revision containing the source code that was released. The
 data type is determined by the version control system plugin that was used. The example code shown
diff --git a/wiki/pages/_Footer.md b/wiki/pages/_Footer.md
@@ -1,4 +1,4 @@
 [![Google Group](https://img.shields.io/badge/rez--config-Google%20Group-blue?style=flat-square&logo=google)](https://groups.google.com/forum/#!forum/rez-config)
-[![Contributing Guidelines](https://img.shields.io/badge/rez-Contributing%20Guidelines-0b610e?style=flat-square&logo=github)](https://github.com/__GITHUB_REPO__/blob/master/CONTRIBUTING.md)
+[![Contributing Guidelines](https://img.shields.io/badge/rez-Contributing%20Guidelines-0b610e?style=flat-square&logo=github)](https://github.com/__GITHUB_REPO__/blob/main/CONTRIBUTING.md)
 [![Report A Bug](https://img.shields.io/badge/rez-Report%20A%20Bug-critical?style=flat-square&logo=github)](https://github.com/__GITHUB_REPO__/issues/new)
 [![Slack](https://img.shields.io/badge/slack-rez--talk-7a6800?style=flat-square&logo=slack)](https://rez-talk.slack.com/)
