-
-
Notifications
You must be signed in to change notification settings - Fork 528
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into sage_knots_mod
- Loading branch information
Showing
208 changed files
with
12,799 additions
and
13,782 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,8 +4,15 @@ on: | |
| pull_request: | ||
| merge_group: | ||
| push: | ||
| tags: | ||
| # Match all release tags including beta, rc | ||
| - '[0-9]+.[0-9]+' | ||
| - '[0-9]+.[0-9]+.[0-9]+' | ||
| - '[0-9]+.[0-9]+.beta[0-9]+' | ||
| - '[0-9]+.[0-9]+.[0-9]+.beta[0-9]+' | ||
| - '[0-9]+.[0-9]+.rc[0-9]+' | ||
| - '[0-9]+.[0-9]+.[0-9]+.rc[0-9]+' | ||
| branches: | ||
| - master | ||
| - develop | ||
| workflow_dispatch: | ||
| # Allow to run manually | ||
|
|
@@ -34,7 +41,7 @@ env: | |
| EXTRA_CONFIGURE_ARGS: --enable-fat-binary | ||
|
|
||
| jobs: | ||
| build-docs: | ||
| build-doc: | ||
| runs-on: ubuntu-latest | ||
| services: | ||
| # https://docs.docker.com/build/ci/github-actions/local-registry/ | ||
|
|
@@ -114,38 +121,50 @@ jobs: | |
| --workdir $(pwd) \ | ||
| ${{ env.BUILD_IMAGE }} /bin/sh | ||
| # Docs | ||
| # | ||
| # On PRs and pushes to develop | ||
| # | ||
|
|
||
| - name: Store old docs | ||
| - name: Store old doc | ||
| id: worktree | ||
| if: (success() || failure()) && steps.container.outcome == 'success' | ||
| if: (success() || failure()) && steps.container.outcome == 'success' && !startsWith(github.ref, 'refs/tags/') | ||
| run: | | ||
| git config --global --add safe.directory $(pwd) | ||
| git config --global user.email "[email protected]" | ||
| git config --global user.name "Build documentation workflow" | ||
| # mathjax path in old doc (regex) | ||
| mathjax_path_from="[-./A-Za-z_]*/tex-chtml[.]js?v=[0-9a-f]*" | ||
| # mathjax path in new doc | ||
| mathjax_path_to=$(docker exec -e SAGE_USE_CDNS=yes BUILD /sage/sage -python -c "from sage_docbuild.conf import mathjax_path; print(mathjax_path)") | ||
| new_version=$(docker exec BUILD cat src/VERSION.txt) | ||
| mkdir -p docs/ | ||
| docker cp BUILD:/sage/local/share/doc/sage/html docs/ | ||
| # Wipe out chronic diffs of old doc against new doc | ||
| (cd docs && \ | ||
| find . -name "*.html" | xargs sed -i -e '/class="sidebar-brand-text"/ s/Sage [0-9a-z.]* /Sage '"$new_version"' /' \ | ||
| -e '/<link rel="stylesheet"/ s/?v=[0-9a-f]*"/"/' \ | ||
| -e 's;'"$mathjax_path_from"';'"$mathjax_path_to"';' \ | ||
| -e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d') | ||
| # Create git repo from old doc | ||
| (cd docs && \ | ||
| 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: Build docs | ||
| # Check if we are on PR | ||
| PR_NUMBER="" | ||
| if [[ -n "$GITHUB_REF" ]]; then | ||
| if [[ "$GITHUB_REF" =~ refs/pull/([0-9]+)/merge ]]; then | ||
| PR_NUMBER="${BASH_REMATCH[1]}" | ||
| fi | ||
| fi | ||
| # If so, then prepare to create CHANGES.html | ||
| if [[ -n "$PR_NUMBER" ]]; then | ||
| # mathjax path in old doc (regex) | ||
| mathjax_path_from="[-./A-Za-z_]*/tex-chtml[.]js?v=[0-9a-f]*" | ||
| # mathjax path in new doc | ||
| mathjax_path_to=$(docker exec -e SAGE_USE_CDNS=yes BUILD /sage/sage -python -c "from sage_docbuild.conf import mathjax_path; print(mathjax_path)") | ||
| new_version=$(docker exec BUILD cat src/VERSION.txt) | ||
| mkdir -p doc/ | ||
| docker cp BUILD:/sage/local/share/doc/sage/html doc/ | ||
| # Wipe out chronic diffs between old doc and new doc | ||
| (cd doc && \ | ||
| find . -name "*.html" | xargs sed -i -e '/class="sidebar-brand-text"/ s/Sage [0-9a-z.]* /Sage '"$new_version"' /' \ | ||
| -e '/<link rel="stylesheet"/ s/?v=[0-9a-f]*"/"/' \ | ||
| -e 's;'"$mathjax_path_from"';'"$mathjax_path_to"';' \ | ||
| -e '\;<script type="application/vnd\.jupyter\.widget-state+json">;,\;</script>; d') | ||
| # Create git repo from old doc | ||
| (cd doc && \ | ||
| 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') | ||
| fi | ||
| - name: Build doc | ||
| id: docbuild | ||
| if: (success() || failure()) && steps.worktree.outcome == 'success' | ||
| if: (success() || failure()) && steps.worktree.outcome == 'success' && !startsWith(github.ref, 'refs/tags/') | ||
| # Always non-incremental because of the concern that | ||
| # incremental docbuild may introduce broken links (inter-file references) though build succeeds | ||
| run: | | ||
|
|
@@ -157,50 +176,57 @@ jobs: | |
| ./config.status && make sagemath_doc_html-no-deps | ||
| shell: sh .ci/docker-exec-script.sh BUILD /sage {0} | ||
|
|
||
| - name: Copy docs | ||
| - name: Copy doc | ||
| id: copy | ||
| if: (success() || failure()) && steps.docbuild.outcome == 'success' | ||
| run: | | ||
| set -ex | ||
| # We copy everything to a local folder | ||
| docker cp BUILD:/sage/local/share/doc/sage/html docs | ||
| docker cp BUILD:/sage/local/share/doc/sage/index.html docs | ||
| (cd docs && git commit -a -m 'new') | ||
| # Wipe out chronic diffs of new doc against old doc | ||
| (cd docs && \ | ||
| 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 docs && git rev-parse HEAD^) docs | ||
| # Restore the new doc from changes by "wipe out" | ||
| (cd docs && git checkout -f) | ||
| (cd docs && rm -rf .git) | ||
| mv CHANGES.html docs | ||
| # We also need to replace the symlinks because netlify is not following them | ||
| # CHECK IF STILL NEEDED | ||
| #cp -r -L $DOC_DIR ./docs | ||
| 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 | ||
| # Check if we are on PR | ||
| PR_NUMBER="" | ||
| if [[ -n "$GITHUB_REF" ]]; then | ||
| if [[ "$GITHUB_REF" =~ refs/pull/([0-9]+)/merge ]]; then | ||
| PR_NUMBER="${BASH_REMATCH[1]}" | ||
| fi | ||
| fi | ||
| # If so, then create CHANGES.html | ||
| if [[ -n "$PR_NUMBER" ]]; then | ||
| (cd doc && git commit -a -m 'new') | ||
| # 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 of/ s/ built with GitHub PR .* for development/ for development/' \ | ||
| -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) | ||
| mv CHANGES.html doc | ||
| fi | ||
| # Zip everything for increased performance | ||
| zip -r docs.zip docs | ||
| zip -r doc.zip doc | ||
| - name: Upload docs | ||
| - name: Upload doc | ||
| id: upload | ||
| if: (success() || failure()) && steps.copy.outcome == 'success' | ||
| uses: actions/upload-artifact@v3 | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: docs | ||
| path: docs.zip | ||
| name: doc | ||
| path: doc.zip | ||
|
|
||
| - name: Save space | ||
| id: savespace | ||
| if: (success() || failure()) && steps.upload.outcome == 'success' && github.repository == 'sagemath/sage' && github.ref == 'refs/heads/develop' | ||
| run: | | ||
| set -ex | ||
| # Save space on runner device before we start to build livedoc | ||
| rm -rf docs/ | ||
| rm -f docs.zip | ||
| # | ||
| # On release tags: live doc and wheels | ||
| # | ||
|
|
||
| - name: Build live doc | ||
| id: buildlivedoc | ||
| if: (success() || failure()) && steps.savespace.outcome == 'success' | ||
| if: (success() || failure()) && startsWith(github.ref, 'refs/tags/') | ||
| run: | | ||
| export MAKE="make -j5 --output-sync=recurse" SAGE_NUM_THREADS=5 | ||
| export PATH="build/bin:$PATH" | ||
|
|
@@ -222,12 +248,12 @@ jobs: | |
| # We copy everything to a local folder | ||
| docker cp --follow-link BUILD:/sage/local/share/doc/sage/html livedoc | ||
| docker cp --follow-link BUILD:/sage/local/share/doc/sage/pdf livedoc | ||
| docker cp BUILD:/sage/local/share/doc/sage/index.html livedoc | ||
| docker cp --follow-link BUILD:/sage/local/share/doc/sage/index.html livedoc | ||
| zip -r livedoc.zip livedoc | ||
| - name: Upload live doc | ||
| if: (success() || failure()) && steps.copylivedoc.outcome == 'success' | ||
| uses: actions/upload-artifact@v3 | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: livedoc | ||
| path: livedoc.zip | ||
|
|
||
Oops, something went wrong.