Add comment at the top of version check workflow

TuringLang · Aug 14, 2024 · bc2370e · bc2370e
1 parent 33f5ff0
commit bc2370e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.github/workflows/version_check.yml b/.github/workflows/version_check.yml
@@ -1,3 +1,11 @@
+# This action checks that the minor versions of Turing.jl specified in the
+# Project.toml, _quarto.yml, and Manifest.toml files are consistent.
+#
+# For pushes to master or PRs to master, it additionally also checks that the
+# version specified in Manifest.toml matches the latest release on GitHub.
+# 
+# If any discrepancies are observed, it will open a PR to fix them.
+
 name: Check Turing.jl version consistency
 on:
   push: