-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1754 from GaloisInc/add-book-ci
ci: add a check for the cryptol book pdf
- Loading branch information
Showing
4 changed files
with
130 additions
and
7 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# Indicates whether the Programming Cryptol book PDF needs to be updated. | ||
# | ||
# Usage | ||
# This is primarily for use in CI. You can run it locally using the following: | ||
# > bash check_book_update.sh $(git diff --name-only --diff-filter ACDMRT master) | ||
# | ||
# If you are merging to a branch other than `master`, use that branch name | ||
# instead. | ||
# | ||
|
||
TEX_CHANGED=0 | ||
PDF_CHANGED=0 | ||
|
||
# Examine the set of changed files to see if either the book source code | ||
# or the book PDF were changed. | ||
for fname in $@ ; do | ||
case $fname in | ||
docs/ProgrammingCryptol/*) | ||
TEX_CHANGED=1 | ||
TEX_FILES="$TEX_FILES$fname " ;; | ||
docs/ProgrammingCryptol.pdf) | ||
PDF_CHANGED=1 ;; | ||
esac | ||
done | ||
|
||
if (($TEX_CHANGED)) && ((! $PDF_CHANGED)); then | ||
echo -e "Changed files: $TEX_FILES" | ||
echo "The Programming Cryptol source code changed, but the PDF was" | ||
echo "not updated. Please rebuild the book to incorporate your changes" | ||
echo "and copy the file to 'docs/ProgrammingCryptol.pdf'." | ||
exit 1 | ||
elif (($TEX_CHANGED)) && (($PDF_CHANGED)); then | ||
echo "Thanks for updating the PDF along with your changed source code!" | ||
echo "This CI job doesn't check that you incorporated all the source" | ||
echo "changes into the PDF; please confirm that it's properly updated" | ||
echo "before merging." | ||
exit 0 | ||
elif ((! $TEX_CHANGED)) && (($PDF_CHANGED)); then | ||
echo "The Programming Cryptol PDF changed but there was no corresponding" | ||
echo "change to the source code." | ||
exit 1 | ||
else | ||
echo "There were no changes to the book. No action needed." | ||
exit 0 | ||
fi |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# | ||
# Checks that the PDF version of the Programming Cryptol book was updated | ||
# if and only if the constituent source files were changed. | ||
# | ||
|
||
name: Programming Cryptol PDF Update | ||
on: [pull_request] | ||
|
||
jobs: | ||
update_needed: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- id: checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- name: "Check if update to local PDF is needed" | ||
run: | | ||
changed_files=$(git diff --name-only --diff-filter ACDMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }}) | ||
# This will fail if any files have spaces in the names. | ||
bash .github/check_book_update.sh $changed_files |
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