Clear Badge Cache is a tool designed to purge cached GitHub badge images. Based on the repository URL and badge file, it will delete the cached image from the GitHub CDN.
Inspired by github-badge-cache-buster
There is a large list of bugs open (and incorrectly closed) relating to this.
The main issue is
- #224 - Aggressive image caching breaks image badges
Some of the others are.....
- #9 - GitHub Image Proxy breaking Nodei.co images in markdown
- #15 - Badges do not update with GitHubs caching
- #111 - can't find the URL for this one
- #116 - can't find the URL for this one
- #134 - Serve cached images upon request timeout
- #137 - Travis badges seem to be broken
- #218 - GitHub caching affecting my badge
- #220 - Set
Cache-Control
orExpires
on S3 assets - #257 - Badge caching
- #414 - Incorrect coverage badge
- #1970 - Build status image cached by GitHub
- #3122 - Code Coverage Status Badge is cached
- #3150 - Unix nightly badge is inaccurate
- #6040 - fix coveralls badge issue in README
- #17057 - Aggressive GitHub caching breaks Gitlab badge images.
More information here.
Command Line Arguments 🖊️
You can provide the repository URL and optionally a badge file as command-line arguments:
clear-badge-cache [repoURL] [badgeFile]
If no arguments are provided, the program will prompt you to enter the repository URL.
Help
To display the help message, use the -h
or --help
flag:
clear-badge-cache -h
The help message is as follows:
usage: clear-badge-cache [ -h | --help | [ repoURL [ badgeFile ] ] ]
repoURL required unless provided on command line
badgeFile defaults to ''