Merge pull request #1400 from urfave/docs-publish-debugging

Docs publishing fixes

.github/workflows/cli.yml

@@ -76,18 +76,14 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install Dependencies
-        run:
-          mkdir -p "${GITHUB_WORKSPACE}/.local/bin" &&
-          curl -fsSL -o "${GITHUB_WORKSPACE}/.local/bin/gfmrun" "https://github.com/urfave/gfmrun/releases/download/v1.3.0/gfmrun-$(go env GOOS)-$(go env GOARCH)-v1.3.0" &&
-          chmod +x "${GITHUB_WORKSPACE}/.local/bin/gfmrun" &&
-          npm install -g markdown-toc@1.2.0
+        run: |
+          mkdir -p "${GITHUB_WORKSPACE}/.local/bin"
+          curl -fsSL -o "${GITHUB_WORKSPACE}/.local/bin/gfmrun" "https://github.com/urfave/gfmrun/releases/download/v1.3.0/gfmrun-$(go env GOOS)-$(go env GOARCH)-v1.3.0"
+          chmod +x "${GITHUB_WORKSPACE}/.local/bin/gfmrun"
 
       - name: gfmrun
         run: go run internal/build/build.go gfmrun docs/v2/manual.md
 
-      - name: toc
-        run: go run internal/build/build.go toc docs/v2/manual.md
-
       - name: diff check
         run: |
           git diff --exit-code
@@ -96,13 +92,21 @@ jobs:
   publish:
     if: startswith(github.ref, 'refs/tags/')
     name: publish
+    needs: [test-docs]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup mkdocs
+        run: |
+          pip install -U pip
+          pip install -r mkdocs-requirements.txt
+          git remote rm origin
+          git remote add origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/urfave/cli.git
 
       - name: Publish Docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.MKDOCS_PUBLISH_GITHUB_TOKEN }}
-          REQUIREMENTS: mkdocs-requirements.txt
+        run: |
+          mkdocs gh-deploy --force

Makefile

@@ -5,7 +5,7 @@
 # attention on files that are primarily Go.
 
 .PHONY: all
-all: generate vet tag-test test check-binary-size tag-check-binary-size gfmrun toc v2diff
+all: generate vet tag-test test check-binary-size tag-check-binary-size gfmrun v2diff
 
 # NOTE: this is a special catch-all rule to run any of the commands
 # defined in internal/build/build.go with optional arguments passed
@@ -27,10 +27,6 @@ tag-check-binary-size:
 gfmrun:
 	go run internal/build/build.go gfmrun docs/v2/manual.md
 
-.PHONY: toc
-toc:
-	go run internal/build/build.go toc docs/v2/manual.md
-
 .PHONY: docs
 docs:
 	mkdocs build

internal/build/build.go

@@ -63,10 +63,6 @@ func main() {
 			Name:   "gfmrun",
 			Action: GfmrunActionFunc,
 		},
-		{
-			Name:   "toc",
-			Action: TocActionFunc,
-		},
 		{
 			Name:   "check-binary-size",
 			Action: checkBinarySizeActionFunc,
@@ -216,15 +212,6 @@ func GfmrunActionFunc(c *cli.Context) error {
 	return runCmd("gfmrun", "-c", fmt.Sprint(counter), "-s", filename)
 }
 
-func TocActionFunc(c *cli.Context) error {
-	filename := c.Args().Get(0)
-	if filename == "" {
-		filename = "README.md"
-	}
-
-	return runCmd("markdown-toc", "-i", filename)
-}
-
 // checkBinarySizeActionFunc checks the size of an example binary to ensure that we are keeping size down
 // this was originally inspired by https://github.com/urfave/cli/issues/1055, and followed up on as a part
 // of https://github.com/urfave/cli/issues/1057

mkdocs-requirements.txt

@@ -1,4 +1,5 @@
-mkdocs~=1.3
-mkdocs-material~=8.2
 mkdocs-git-revision-date-localized-plugin~=1.0
+mkdocs-material-extensions~=1.0
+mkdocs-material~=8.2
+mkdocs~=1.3
 pygments~=2.12