Specify branch name as "master" instead of "main" (modern default)

microbiomedata · Nov 7, 2024 · 87815d9 · 87815d9
1 parent 9cf3364
commit 87815d9
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/.github/workflows/fetch-and-compile-mag-workflow-documentation.yml b/.github/workflows/fetch-and-compile-mag-workflow-documentation.yml
@@ -15,14 +15,15 @@ jobs:
         # Docs: https://github.com/actions/checkout
       - name: Check out commit
         uses: actions/checkout@v4
-      - name: Check out commit from `metaMAGs/main`
+        # Note: The default branch of the `metaMAGs` repository is named "master"
+      - name: Check out commit from `metaMAGs/master`
         uses: actions/checkout@v4
         with:
           # Notes:
           # - `repository` format is: "{owner_name}/{repo_name}"
-          # - `sparse-checkout` lists the same files as the `mkdocs.yml` GHA workflow in `nmdc-runtime`
+          # - The default branch of the `metaMAGs` repository is named "master"
           repository: microbiomedata/metaMAGs  # format is "{owner_name}/{repo_name}"
-          ref: main
+          ref: master
           sparse-checkout: |
             docs
           path: _clones/microbiomedata/metaMAGs  # where, locally, to create the clone