Skip to content

docs: note jsDelivr as alternative fetch URL #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kwit75 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: note jsDelivr as alternative fetch URL #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ Hosting an announcement here means it shows up in every running extension within
## Operational notes

- The fetch URL is `https://raw.githubusercontent.com/rocketride-org/announcements/main/announcements.json` — pinned to `main` branch.
- Raw content is served via GitHub's CDN; updates propagate within ~5 minutes globally.
- Extension cache TTL is 1 hour; users see new announcements within an hour of merge, sooner on extension restart.
- Raw content is served via GitHub's CDN with a ~5 minute default TTL per IP; updates propagate globally within that window. Extension cache TTL is 1 hour on top, so users see new announcements within an hour of merge (sooner on extension restart).
- No secrets, no auth, no infrastructure to maintain — by design.

### Alternative fetch URL (if we ever need it)

Raw GitHub serves the file with `Content-Type: text/plain` and has [documented occasional caching hiccups](https://github.com/orgs/community/discussions/169198). For our volume that's been a non-issue, but if we ever do hit problems the lowest-cost swap is jsDelivr, which is a CDN purpose-built for fronting GitHub repos:

```
https://cdn.jsdelivr.net/gh/rocketride-org/announcements@main/announcements.json
```

jsDelivr fixes the Content-Type (serves `application/json` correctly), offers a stable global CDN, and supports `@branch`, `@tag`, and `@commit-sha` pinning syntax. The swap is a one-line change in the extension fetch URL. Documenting it here as a known escape hatch.