Release Manager · Release Manager · commit 31b186ce3586 · 2024-07-04T00:37:10.000+02:00
sagemathgh-38274: Fix broken anchors in CHANGES.html of doc preview       broken by careless code in sagemath#38213: ``` # Restore the new doc from changes by "wipe out" (cd docs && git checkout -f) ``` which also wipes out anchors planted by `.ci/create-changes-html.sh`! To reviewer: changes over sagemath#38220 is in https://github.com/sagemath/sage/ pull/38274/commits/d2d1514148f46a4ceeea650eab1fd0a0800ebbc9 Tested in : https://github.com/kwankyu/sage/actions/runs/9659812609/job/26643993813. Try to open https://doc-pr-43--sagemath- test.netlify.app/html/en/reference/references/#hunk2 to check ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies    sagemath#38220 URL: sagemath#38274 Reported by: Kwankyu Lee Reviewer(s):
diff --git a/.ci/create-changes-html.sh b/.ci/create-changes-html.sh
@@ -8,8 +8,6 @@ fi
 BASE_DOC_COMMIT="$1"
 DOC_REPOSITORY="$2"
 
-# Wipe out chronic diffs between old doc and new doc
-(cd $DOC_REPOSITORY && find . -name "*.html" | xargs sed -i -e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d')
 # Create CHANGES.html
 echo '<html>' > CHANGES.html
 echo '<head>' >> CHANGES.html
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -150,7 +150,7 @@ jobs:
            git init && \
            (echo "*.svg binary"; echo "*.pdf binary") >> .gitattributes && \
            (echo ".buildinfo"; echo '*.inv'; echo '.git*'; echo '*.svg'; echo '*.pdf'; echo '*.png'; echo 'searchindex.js') > .gitignore; \
-           git add -A && git commit --quiet -m "old")
+           git add -A && git commit --quiet -m 'old')
 
       - name: Build doc
         id: docbuild
@@ -175,13 +175,16 @@ jobs:
           docker cp --follow-link BUILD:/sage/local/share/doc/sage/html doc
           docker cp --follow-link BUILD:/sage/local/share/doc/sage/index.html doc
           (cd doc && git commit -a -m 'new')
-          # Wipe out chronic diffs of new doc against old doc
+          # Wipe out chronic diffs of new doc against old doc before creating CHANGES.html
           (cd doc && \
            find . -name "*.html" | xargs sed -i -e '/This is documentation for/ s/ built with GitHub PR .*. Doc/. Doc/' \
-                                                -e '/<link rel="stylesheet"/ s/?v=[0-9a-f]*"/"/')
-          .ci/create-changes-html.sh $(cd doc && git rev-parse HEAD^) doc
-          # Restore the new doc from changes by "wipe out"
-          (cd doc && git checkout -f)
+                                                -e '/<link rel="stylesheet"/ s/?v=[0-9a-f]*"/"/' \
+                                                -e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d' \
+           && git commit -a -m 'wipe-out')
+          # Since HEAD is at commit 'wipe-out', HEAD~1 is commit 'new' (new doc), HEAD~2 is commit 'old' (old doc)
+          .ci/create-changes-html.sh $(cd doc && git rev-parse HEAD~2) doc
+          # Restore the new doc with changes made in create-changes-html.sh but dropping changes by "wipe out"
+          (cd doc && git stash -q && git checkout -q -f HEAD~1 && git stash pop -q)
           # Sometimes rm -rf .git errors out because of some diehard hidden files
           # So we simply move it out of the doc directory
           (cd doc && mv .git ../git && mv .gitattributes ../gitattributes)
