Set Cache-Control: no-cache for redirects to badges #1653
Merged
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.
The badges provided by readthedocs.org are created using shields.io, using a redirect. We did not have the Cache-Control set on those redirects which might make GitHub cache the badges too aggressively when they are used in a README file.
The github/markup#224 issue explains that we need to set the Cache-Control and ETag header to disable caching for the badges. However we are not serving the badges, but redirecting, so we just need to try out whether a Cache-Control header on the redirect has any effect. I did a quick google search but was not able to find if it's valid to set ETag headers on a redirect. I think it's nonsense as the body of a redirect response is usually empty.
Related #1612