Skip to content

.github/workflows/doc-build.yml: Fix generation of CHANGES.html #35808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 1, 2023
Merged

.github/workflows/doc-build.yml: Fix generation of CHANGES.html #35808

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9905d4e
.github/workflows/doc-build.yml: Save/restore the git repo of the bui…
mkoeppe Jun 22, 2023
396229b
Fixup
mkoeppe Jun 23, 2023
cdd675d
.github/workflows/doc-build.yml: For CHANGES.html, ignore git, image,…
mkoeppe Jun 24, 2023
ebde730
.github/workflows/doc-build.yml: Only patch versions in the old HTML …
mkoeppe Jun 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/doc-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
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
Expand Down Expand Up @@ -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/.git
./config.status && make doc-html
Copy link
Collaborator

@kwankyu kwankyu Jun 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move .git-doc to .git-doc? No .git?

Where is the code to generate CHANGES.html? No idea how this works.

Copy link
Contributor Author

@mkoeppe mkoeppe Jun 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, fixed now.

CHANGES.html is generated in the "Copy docs" step

Copy link
Collaborator

@kwankyu kwankyu Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you aware that L53 is very similar to L100 in the "Copy docs" step. This seems to be a mistake to me...

Copy link
Collaborator

@kwankyu kwankyu Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are.

Copy link
Collaborator

@kwankyu kwankyu Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the net effect of L83 and L85. It is moving .git directory to and from .gitdoc. Why?

Copy link
Collaborator

@kwankyu kwankyu Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In particular, why mkdir -p /sage/local/share/doc/sage/html/en/. The directory already exists. Why create it again?

Copy link
Contributor Author

@mkoeppe mkoeppe Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm moving the .git directory away and back to protect it from make doc-uninstall

Copy link
Collaborator

@kwankyu kwankyu Jun 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

working-directory: ./worktree-image
env:
MAKE: make -j2
Expand All @@ -94,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 '<p><a href="html.diff">HTML diff</a>'; sed -E 's,(.*),<p><a href="\1">\1</a>,' ./docs/CHANGES.txt) > ./docs/CHANGES.html
Expand Down