Skip to content

docs(rum-legacy): name the current release in the bundle urls - #35

Closed
Fiona2016 wants to merge 1 commit into
mainfrom
docs/legacy-readme-name-current-release
Closed

docs(rum-legacy): name the current release in the bundle urls#35
Fiona2016 wants to merge 1 commit into
mainfrom
docs/legacy-readme-name-current-release

Conversation

@Fiona2016

Copy link
Copy Markdown
Collaborator

Follow-up to #34, which left the bundle urls with a <version> placeholder.

A placeholder makes the reader look the version up before they can fetch anything, and the reason the previous version was written as one does not hold: release directories are never overwritten, so a url that names a release keeps working indefinitely. A named version that falls behind hands back an older bundle — the failure #34 fixed was a version that was never released at all, which returned 404.

So the urls name v0.1.0, the current release and the first to carry this build, and the sentence below them says so.

Verification

  • Both urls return 200 as of this commit: fc-rum-legacy.js (11880 bytes), flashcat-rum.js ("0.1.0").
  • prettier --check passes.
  • The ES3 parse gate over the README's <script> snippets still finds and passes 2 snippets; no snippet was touched.

One thing this does not solve

The version is now a literal that a release does not update, so it goes stale on the next one. That is a smaller failure than the one it replaces — an older bundle rather than a 404 — but it is the same shape of problem. Worth a CI assertion that the version in this README matches lerna.json; scripts/check-es5-compatibility.js already reads this file and would be the place for it. Left out of this PR because it changes what can block a release.

A placeholder makes the reader look the version up before they can
fetch anything. Release directories are never overwritten, so a url
that names one keeps working: a version that falls behind hands back
an older bundle, where the unreleased one it replaced returned 404.
@Fiona2016

Copy link
Copy Markdown
Collaborator Author

Superseded: the bundle urls will keep the <version> placeholder, and a new SDK versions page in the docs site becomes the place to look the version up. Closing in favour of the follow-up that adds that link and applies the same treatment to the root README.

@Fiona2016 Fiona2016 closed this Sep 1, 2026
@Fiona2016
Fiona2016 deleted the docs/legacy-readme-name-current-release branch September 1, 2026 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant