From 1ba1a854f9d49c3721671bf308541b40a8d5ba3a Mon Sep 17 00:00:00 2001
From: Nick Cross <ncross@redhat.com>
Date: Thu, 21 May 2026 09:26:18 +0100
Subject: [PATCH] Add README ToC generator

---
 .github/workflows/private-toc.yml | 45 +++++++++++++++++++++++++++++++
 README.md                         |  6 +++++
 2 files changed, 51 insertions(+)
 create mode 100644 .github/workflows/private-toc.yml

diff --git a/.github/workflows/private-toc.yml b/.github/workflows/private-toc.yml
new file mode 100644
index 0000000..093d269
--- /dev/null
+++ b/.github/workflows/private-toc.yml
@@ -0,0 +1,45 @@
+# This is not meant to be copied and is only for this repository.
+name: Update README table of contents
+on:
+  workflow_dispatch:
+  push:
+    branches:
+    - main
+    paths:
+    - README.md
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # Allows pushing commits.
+
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      with:
+        persist-credentials: false
+
+    - name: Configure Git User
+      run: |
+        # This sets the name and email for the commits
+        git config --global user.name "github-actions[bot]"
+        # official github action email
+        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+    - name: Update TOC
+      run: npx --yes doctoc README.md
+
+    - name: Commit and push if README changed
+      run: |-
+        git diff
+        git diff --quiet || (git add README.md && git commit -m "Updated README ToC")
+        git push
+      env:
+        # Use the standard GITHUB_TOKEN or a Custom PAT if pushing to other repos
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
index a0b4ef6..e84894c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
+
+# Table of Contents
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
 # Introduction
 
 This repository is used to store GitHub Action workflows (and other stuff) that we'll re-use in other PNC repositories