Skip to content

Commit c964412

Browse files
author
Release Manager
committed
sagemathgh-39622: Fix CI documentation diff As discussed in sagemath#39542 . Without this, the "Changes is ready!" feature will be broken. Also remove some outdated documentation (the requirement list in update- conda was wrong (toml missing), I just refer to README.md which contains the correct list) ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [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 <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39622 Reported by: user202729 Reviewer(s): Kwankyu Lee, Tobias Diez, user202729
2 parents e4f234f + 3b83e4b commit c964412

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

.github/workflows/doc-build.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,10 @@ jobs:
173173
-e 's;'"$mathjax_path_from"';'"$mathjax_path_to"';' \
174174
-e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d' \
175175
-e 's;#L[0-9]*";";' \
176-
-e 's;tab-set--[0-9]*-;tab-set-;' \
176+
-e 's;tab-set--[0-9]*-;tab-set-;g' \
177+
-e 's;"tab-set--[0-9]*";"tab-set";' \
177178
&& true)
179+
# If the regex list above is changed, the sed command in "Copy doc" step should also be changed
178180
# Create git repo from old doc
179181
(cd doc && \
180182
git init && \
@@ -229,9 +231,10 @@ jobs:
229231
-e 's;?v=[0-9a-f]*";";' \
230232
-e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d' \
231233
-e 's;#L[0-9]*";";' \
232-
-e 's;tab-set--[0-9]*-;tab-set-;' \
234+
-e 's;tab-set--[0-9]*-;tab-set-;g' \
233235
-e 's;"tab-set--[0-9]*";"tab-set";' \
234236
&& git commit -a -m 'wipe-out')
237+
# If the regex list above is changed, the sed command in "Store old doc" step should also be changed
235238
# Since HEAD is at commit 'wipe-out', HEAD~1 is commit 'new' (new doc), HEAD~2 is commit 'old' (old doc)
236239
(cd doc && git diff $(git rev-parse HEAD~2) -- "*.html") > diff.txt
237240
# Restore the new doc dropping changes by "wipe out"

tools/update-conda.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
#!/usr/bin/env python3
2-
# Requirements: pip install https://github.com/conda/grayskull conda-lock
3-
# Usage: python tools/update-conda.py .
2+
# See README.md for more details
43

54
import argparse
65
import subprocess

tools/update-meson.py

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#!/usr/bin/env python3
2+
# See README.md for more details
23

34
import argparse
45
import os

0 commit comments

Comments
 (0)