From 8d2019bb0db81709d162f712aefa68d55f622045 Mon Sep 17 00:00:00 2001
From: Richard Brooksby <rb@ravenbrook.com>
Date: Tue, 26 Nov 2024 16:09:47 +0000
Subject: [PATCH] Adding documentation reference to use of checkout action to
 help clarify why we say "@v4", in response to review comment
 <https://github.com/Ravenbrook/mps/pull/284#pullrequestreview-2461989972>.

---
 .github/workflows/build-and-test.yml     | 4 ++--
 .github/workflows/fixme-check.yml        | 2 +-
 .github/workflows/rst-check.yml          | 2 +-
 .github/workflows/shell-script-check.yml | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
index 28fdb0189c..64d445586a 100644
--- a/.github/workflows/build-and-test.yml
+++ b/.github/workflows/build-and-test.yml
@@ -44,7 +44,7 @@ jobs:
 
     # See design.mps.tests.ci.run.posix.
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v4 # see <https://github.com/actions/checkout/blob/main/README.md#usage>
     - run: CC=${{ matrix.compiler }} ./configure
     - run: make
     - run: make test
@@ -59,7 +59,7 @@ jobs:
     # <https://github.com/actions/runner-images/blob/e6fcf60b8e6c0f80a065327eaefe836881c28b68/images/win/Windows2022-Readme.md?plain=1#L215>.
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v4 # see <https://github.com/actions/checkout/blob/main/README.md#usage>
     - run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64
          cd code
diff --git a/.github/workflows/fixme-check.yml b/.github/workflows/fixme-check.yml
index 40cb9a5725..e42f7fa3bc 100644
--- a/.github/workflows/fixme-check.yml
+++ b/.github/workflows/fixme-check.yml
@@ -17,5 +17,5 @@ jobs:
   check-fixme:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4 # see <https://github.com/actions/checkout/blob/main/README.md#usage>
       - run: tool/check-fixme
diff --git a/.github/workflows/rst-check.yml b/.github/workflows/rst-check.yml
index 46ea28a53d..1f643c5742 100644
--- a/.github/workflows/rst-check.yml
+++ b/.github/workflows/rst-check.yml
@@ -16,7 +16,7 @@ jobs:
   check-rst:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4 # see <https://github.com/actions/checkout/blob/main/README.md#usage>
       - name: Install docutils
         run: sudo apt-get install -y docutils
       - name: Check reStructuredText syntax
diff --git a/.github/workflows/shell-script-check.yml b/.github/workflows/shell-script-check.yml
index ad0a23fdea..e8e9e2ae51 100644
--- a/.github/workflows/shell-script-check.yml
+++ b/.github/workflows/shell-script-check.yml
@@ -16,7 +16,7 @@ jobs:
   check-shell-scripts:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4 # see <https://github.com/actions/checkout/blob/main/README.md#usage>
       - name: Install shellcheck
         run: sudo apt-get install -y shellcheck
       - name: Check shell scripts