From 9905d4e4f11c5c821c3d340310e92d2fa83ceda2 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Thu, 22 Jun 2023 10:59:40 -0700 Subject: [PATCH 1/4] .github/workflows/doc-build.yml: Save/restore the git repo of the built documentation around running doc-clean --- .github/workflows/doc-build.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 01748c3c823..3eb935a634e 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -80,7 +80,10 @@ jobs: # incremental docbuild may introduce broken links (inter-file references) though build succeeds run: | set -ex - make doc-clean doc-uninstall sagelib-clean && git clean -fx src/sage && ./config.status && make doc-html + mv /sage/local/share/doc/sage/html/en/.git /sage/.git-doc + make doc-clean doc-uninstall sagelib-clean && git clean -fx src/sage + mkdir -p /sage/local/share/doc/sage/html/en/ && mv /sage/.git-doc /sage/local/share/doc/sage/html/en/ + ./config.status && make doc-html working-directory: ./worktree-image env: MAKE: make -j2 From 396229bf054f86790dcc0768e78dd0a6a3187b38 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Fri, 23 Jun 2023 08:44:37 -0700 Subject: [PATCH 2/4] Fixup --- .github/workflows/doc-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 3eb935a634e..f65a0e4db0e 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -82,7 +82,7 @@ jobs: set -ex mv /sage/local/share/doc/sage/html/en/.git /sage/.git-doc make doc-clean doc-uninstall sagelib-clean && git clean -fx src/sage - mkdir -p /sage/local/share/doc/sage/html/en/ && mv /sage/.git-doc /sage/local/share/doc/sage/html/en/ + mkdir -p /sage/local/share/doc/sage/html/en/ && mv /sage/.git-doc /sage/local/share/doc/sage/html/en/.git ./config.status && make doc-html working-directory: ./worktree-image env: From cdd675dc0ade30c4831b3329358265da03ace9d6 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Sat, 24 Jun 2023 10:10:25 -0700 Subject: [PATCH 3/4] .github/workflows/doc-build.yml: For CHANGES.html, ignore git, image, index files --- .github/workflows/doc-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index f65a0e4db0e..607ec16172c 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -50,7 +50,7 @@ jobs: if [ ! -f worktree-image/.gitignore ]; then cp .gitignore worktree-image/; fi (cd worktree-image && git add -A && git commit --allow-empty -m "old" -a && git tag -f old && git reset --hard new && git reset old) # Keep track of changes to built HTML - (cd /sage/local/share/doc/sage/html/en && find . -name "*.html" | xargs sed -i '/class="sidebar-brand-text"/s/Sage [0-9a-z.]* /Sage dev /'; git init && (echo ".buildinfo"; echo ".inv") > .gitignore; git add -A && git commit --quiet -m "old") + (cd /sage/local/share/doc/sage/html/en && find . -name "*.html" | xargs sed -i '/class="sidebar-brand-text"/s/Sage [0-9a-z.]* /Sage dev /'; 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") - name: Incremental build id: incremental From ebde7302beb160526afd824b199670b15ece10ea Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Sat, 24 Jun 2023 21:40:17 -0700 Subject: [PATCH 4/4] .github/workflows/doc-build.yml: Only patch versions in the old HTML output --- .github/workflows/doc-build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 607ec16172c..ee2fde3db54 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -50,7 +50,7 @@ jobs: if [ ! -f worktree-image/.gitignore ]; then cp .gitignore worktree-image/; fi (cd worktree-image && git add -A && git commit --allow-empty -m "old" -a && git tag -f old && git reset --hard new && git reset old) # Keep track of changes to built HTML - (cd /sage/local/share/doc/sage/html/en && find . -name "*.html" | xargs sed -i '/class="sidebar-brand-text"/s/Sage [0-9a-z.]* /Sage dev /'; 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") + new_version=$(cat src/VERSION.txt); (cd /sage/local/share/doc/sage/html/en && find . -name "*.html" | xargs sed -i '/class="sidebar-brand-text"/s/Sage [0-9a-z.]* /Sage '$new_version' /'; 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") - name: Incremental build id: incremental @@ -97,7 +97,7 @@ jobs: mkdir -p ./docs # Create changelog echo '## Preview of CHANGES.html' - (cd /sage/local/share/doc/sage/html/en && find . -name "*.html" | xargs sed -i '/class="sidebar-brand-text"/s/Sage [0-9a-z.]* /Sage dev /'; git diff --name-only) | tee ./docs/CHANGES.txt + (cd /sage/local/share/doc/sage/html/en && git diff --name-only) | tee ./docs/CHANGES.txt (cd /sage/local/share/doc/sage/html/en && git diff; rm -rf .git) > ./docs/html.diff echo '## Preview of html.diff'; head -n 400 ./docs/html.diff (echo '

HTML diff'; sed -E 's,(.*),

\1,' ./docs/CHANGES.txt) > ./docs/CHANGES.html