Automatically version documentation assets to prevent stale caches - #121
Merged
Merged
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
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.
Custom theme assets previously kept the same URLs after their contents changed, allowing caches to serve old CSS, JavaScript, logos, and favicons after a deployment. Both documentation versions now generate content-hashed filenames for these assets and reference them in rendered pages. Unchanged assets retain their URLs, while changed assets automatically receive new ones.
A shared MkDocs hook handles versioning, including repeated development builds. Logo styling supports the generated filenames, and CI runs asset-versioning tests. Existing source asset URLs remain available for compatibility. No cache-purge credentials or deployment purge step are required.
Validation:
git diff --checkpasses.