Skip to content

docs: pin the README CDN snippets, and make the release own them #156

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

Merged
adnaan merged 1 commit into from
Aug 2, 2026
Merged

docs: pin the README CDN snippets, and make the release own them #156

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ npm install @livetemplate/client
### CDN

```html
<script src="https://cdn.jsdelivr.net/npm/@livetemplate/client@0.1.0/dist/livetemplate-client.browser.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@livetemplate/client@0.20.0/dist/livetemplate-client.browser.js"></script>
```

## Quick Start
Expand All @@ -42,7 +42,7 @@ npm install @livetemplate/client
<!DOCTYPE html>
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/@livetemplate/client@0.1.0/dist/livetemplate-client.browser.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@livetemplate/client@0.20.0/dist/livetemplate-client.browser.js"></script>
</head>
<body>
<div id="app"></div>
Expand Down
15 changes: 14 additions & 1 deletion scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ restore_release_files() {
# git's stderr is left visible; a generic "couldn't restore" would send the
# next person down the wrong trail.
local f
for f in VERSION package.json package-lock.json CHANGELOG.md; do
for f in VERSION package.json package-lock.json CHANGELOG.md README.md; do
if git cat-file -e "HEAD:$f" 2>/dev/null; then
git checkout HEAD -- "$f" || \
log_warn "Could not restore $f; revert it by hand before retrying"
Expand Down Expand Up @@ -202,6 +202,19 @@ update_versions() {
log_step "Updating package.json to $new_version"
npm version "$new_version" --no-git-tag-version --allow-same-version > /dev/null 2>&1

# The README's CDN snippets carry a literal version, and nothing was
# updating them: they advertised 0.1.0 for nineteen minor releases, and the
# docs site mirrors this file verbatim to /client/, so every reader there
# was told to load a bundle from 2024. A literal that no release step owns
# will always drift, so the release owns it now.
if [ -f README.md ]; then
log_step "Updating README CDN pins to $new_version"
sed -i.bak -E \
"s#(@livetemplate/client@)[0-9]+\.[0-9]+\.[0-9]+#\1${new_version}#g" \
README.md
rm -f README.md.bak
fi

log_info "All version files updated to $new_version"
}

Expand Down
Loading