From 6f0aa275f85dbdc3e36f6bfd94d678f70203939d Mon Sep 17 00:00:00 2001
From: Angus Gratton <angus@redyak.com.au>
Date: Wed, 31 Jan 2024 11:09:52 +1100
Subject: [PATCH] github/workflows: Add comments where tool versions need to be
 in sync.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
---
 .github/workflows/codespell.yml | 1 +
 .github/workflows/ruff.yml      | 1 +
 .pre-commit-config.yaml         | 2 ++
 3 files changed, 4 insertions(+)

diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
index 47b12051e7..2d8b4627aa 100644
--- a/.github/workflows/codespell.yml
+++ b/.github/workflows/codespell.yml
@@ -7,6 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+    # codespell version should be kept in sync with .pre-commit-config.yml
     - run: pip install --user codespell==2.2.6 tomli
     - run: codespell
 
diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml
index 1159a1882d..77a8bd1e9f 100644
--- a/.github/workflows/ruff.yml
+++ b/.github/workflows/ruff.yml
@@ -6,6 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
+    # ruff version should be kept in sync with .pre-commit-config.yaml
     - run: pip install --user ruff==0.1.3
     - run: ruff check --output-format=github .
     - run: ruff format --diff .
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 0576a158b4..a1c811339a 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -12,11 +12,13 @@ repos:
         verbose: true
         stages: [commit-msg]
   - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Version should be kept in sync with .github/workflows/ruff.yml
     rev: v0.1.3
     hooks:
       - id: ruff
       - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
+    # Version should be kept in sync with .github/workflows/codespell.yml
     rev: v2.2.6
     hooks:
       - id: codespell