Add header, track build ref

.github/workflows/ci.yml

@@ -169,7 +169,7 @@ jobs:
         run: |
           chmod +x ./restylers-docs
 
-          ./restylers-docs restylers.yaml > _docs/restylers.md
+          ./restylers-docs $GH_REF restylers.yaml > _docs/restylers.md
 
           git config user.name "github-actions[bot]"
           git config user.email "[email protected]"
@@ -180,6 +180,8 @@ jobs:
           fi
 
           git push
+        env:
+          GH_REF: ${{ github.ref }}
 
   release:
     if: ${{ github.ref == 'refs/heads/main' }}

_tools/restylers-docs/src/Restylers/Docs/Main.hs

@@ -15,9 +15,9 @@ main :: IO ()
 main = do
   args <- getArgs
   case args of
-    [path] -> do
+    [ref, path] -> do
       restylers <- Yaml.decodeFileThrow path
-      T.putStrLn $ renderDocs restylers
+      T.putStrLn $ renderDocs (pack ref) restylers
     _ -> do
-      hPutStrLn stderr "Usage: restyler-docs <manifest>"
+      hPutStrLn stderr "Usage: restyler-docs <ref> <manifest>"
       exitWith $ ExitFailure 64

_tools/restylers-docs/src/Restylers/Docs/Render.hs

@@ -19,13 +19,22 @@ import Restylers.Manifest (Restyler (..))
 import Restylers.Name (RestylerName (..))
 import Text.Shakespeare.Text (st)
 
-renderDocs :: [Restyler] -> Text
-renderDocs restylers =
+renderDocs :: Text -> [Restyler] -> Text
+renderDocs ref restylers =
   T.unlines
-    $ restylersTable restylers
+    $ [header ref]
+    <> restylersTable restylers
     <> ["---"]
     <> map restylerSection restylers
 
+header :: Text -> Text
+header ref =
+  [st|
+# Restylers
+
+Built from `#{ref}`
+|]
+
 restylersTable :: [Restyler] -> [Text]
 restylersTable restylers = headerRows <> map restylerTableRow restylers
  where