Remove Zenodo badge, patch Doxygen's cookie.js to store in session storage.
#373
Conversation
This file contains hidden or 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
Resolves #370 but might break certain browsers.
samcunliffe
commented
Sep 5, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request addresses issue #370 by removing the Zenodo badge from the README and implementing a privacy-focused solution for Doxygen's cookie handling. The changes replace traditional browser cookies with sessionStorage to improve privacy compliance.
- Replaces Doxygen's cookie.js with a custom version that uses sessionStorage instead of cookies
- Removes the Zenodo badge from README.md and replaces it with a static DOI badge
- Updates the GitHub Actions workflow to patch the generated Doxygen documentation with the custom cookie.js
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| doc/js/cookie.js | New custom cookie.js implementation using sessionStorage instead of browser cookies |
| README.md | Removes Zenodo badge, adds static DOI badge, and includes various formatting improvements |
| .github/workflows/doxygen-gh-pages.yml | Adds step to copy custom cookie.js to override Doxygen's default implementation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
samcunliffe
commented
Sep 5, 2025
Comment on lines
+46
to
+48
| - name: Manually patch cookie.js | ||
| run: cp doc/js/cookie.js html/cookie.js | ||
| shell: bash |
Member
Author
There was a problem hiding this comment.
Stupid reformatting of this file but these three lines do the actual patching.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #370 but might break certain browsers.
To actually see what I've done...
cd /place/where/tdms/is git checkout sc/patch-cookies doxygen doc/Doxyfileand check the diff of
doc/js/cookie.jswith thehtml/cookie.jsthat was created by Doxygen. I've removed all cookie-writing to cookies, and put intosessionStorage.A less nuclear option (if this breaks too many browsers) is to override the default cookie duration to
days=0, which makes it session-expiring, and setSameSite=Strict, which is a bit better than the current situation.