Generate a TOC for the readme

Author: tedivm

.gitignore

@@ -0,0 +1,2 @@
+/scripts/gh-md-toc
+test_readme.md

action.yml

@@ -88,6 +88,12 @@ runs:
       shell: bash
       run: "python -m pip install jinja2 pyyaml"
 
+    - name: "Install github-markdown-toc"
+      shell: bash
+      run: |
+        curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o ${{ github.action_path }}/scripts/gh-md-toc
+        chmod a+x ${{ github.action_path }}/scripts/gh-md-toc
+
     - name: "Update README.md"
       shell: bash
       run: "bash ${{ github.action_path }}/scripts/update_readme.sh \"${{ inputs.readme_path }}\""

scripts/update_readme.sh

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+set -e
+
 if [[ $SKIP_README == "true" ]]; then
   echo "Generation of README.md is disabled."
   exit 0
@@ -19,3 +21,8 @@ else
 fi
 
 python $SCRIPT_DIR/../readme_builder.py > $1
+
+# If TOC tag is in the readme generate and add the TOC.
+if grep -q "<\!\-\-ts\-\->" "$1"; then
+  $SCRIPT_DIR/gh-md-toc --insert --no-backup --hide-footer $1
+fi

templates/README.md

@@ -1,9 +1,11 @@
 {% set short_repository = repository.split("/")[1] -%}
 # {{ short_repository }}
 
-
 {{ description }}
 
+<!--ts-->
+<!--te-->
+
 ## Benefits
 
 ### Multi Architecture Builds
@@ -38,6 +40,8 @@ Containers are rebuilt weekly in order to take on the security patches from upst
 
 {{ quick_start }}
 
+{{ documentation }}
+
 ## Python Versions
 
 This project actively supports these Python versions:
@@ -81,4 +85,3 @@ Every tag in this repository supports these architectures:
 
 {{ tags }}
 
-{{ documentation }}

test.sh

@@ -7,5 +7,6 @@ export PACKAGE_VERSIONS="0.13.3 0.13.4 0.14.0 0.15.0"
 export PYTHON_VERSIONS="3.6 3.7 3.8 3.9 3.10"
 export ORGANIZATION="TestOrganization"
 export REPOSITORY="TestOrganization/TestRepository"
+export REPOSITORY_SHORT="TestRepository"
 
-./scripts/update_readme.sh -
+./scripts/update_readme.sh ./test_readme.md