trending/coursebook
1
0
Fork 0
mirror of https://github.com/cs341-illinois/coursebook.git synced 2026-10-01 23:54:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

site_deploy: bump the _coursebook pointer instead of only nudging

Browse Source 
The website consumes the wiki through the _coursebook submodule and
updates it with --remote, so the SHA recorded in the site's tree never
affects what deploys. It had drifted months behind as a result, which is
a trap for anyone who runs a plain 'git submodule update' and then builds
a stale book.

The trigger commit this script already pushes is the natural place to fix
that: point the gitlink at the wiki commit push_to_wiki.sh just published,
so the recorded pointer matches reality at no extra cost. ls-remote plus
update-index writes the gitlink directly, so the shallow clone never has
to fetch the submodule.

Both steps are non-fatal. The push is what rebuilds the site, and under
'set -e' a transient ls-remote failure would otherwise skip it. The commit
keeps --allow-empty so an already-current pointer still triggers a build.
This commit is contained in:
Lawrence Angrave
2026-08-26 14:00:32 -05:00
parent 165a7eee81
commit 73a0f1e976
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_scripts/site_deploy.sh
+23
View File
@@ -12,6 +12,29 @@ export DOCS_SHA=$(git rev-parse --short HEAD)
git clone -b develop --depth 1 git@github.com:cs341-illinois/cs341-illinois.github.io.git ${CLONE_DIR}
cd ${CLONE_DIR}
# The site reads the coursebook through the _coursebook submodule, and its
# workflow updates that with --remote, so the build always takes the wiki's
# latest commit and the SHA recorded in the tree is ignored. Leaving that
# SHA to rot is still a trap: anyone running a plain 'git submodule update'
# builds a months-old book. Point it at the wiki commit push_to_wiki.sh
# just published, so the recorded pointer matches what actually deploys.
#
# ls-remote means we never fetch the submodule: a gitlink is just an index
# entry, so update-index can write it directly into this shallow clone.
# Both steps are non-fatal on purpose. This script runs under 'set -e' and
# its real job is the push below, which is what rebuilds the site; a
# transient ls-remote failure must not cost us the rebuild.
WIKI_SHA=$(git ls-remote "https://github.com/${GITHUB_REPOSITORY}.wiki.git" refs/heads/master | cut -f1) || true
if [ -n "${WIKI_SHA}" ]; then
git update-index --add --cacheinfo "160000,${WIKI_SHA},_coursebook" \
|| echo "Could not write the submodule pointer; pushing without the bump"
else
echo "Could not resolve the wiki head; leaving the submodule pointer alone"
fi
# --allow-empty because the pointer is often already current -- there is
# nothing to commit then, but the push still has to happen: it is the empty
# commit that triggers the site's Website Deploy workflow.
git commit --allow-empty -m "Updating docs to ${DOCS_SHA}"
git push origin develop