docs(rum-legacy): point the CDN examples at paths that exist - #34
Merged
Conversation
The bundle urls named v0.0.8, a version that was never released. This build first shipped in v0.1.0, so both of those urls 404 and a reader copying them gets nothing. Use a <version> placeholder rather than a literal that goes stale on the next release, and say which release the legacy bundle starts at, since the directories of earlier ones exist but hold no fc-rum-legacy.js. The sync-bundles example passed `v0`, a directory the release tooling never writes: deploy-oss.js uploads under the full version, and what sits at v0 predates the legacy build entirely. The command therefore fails on fc-rum-legacy.js. Drop the arguments so the script takes the version from lerna.json and stays correct release to release, and note that its arguments are positional, so an output directory cannot be given without naming a version first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 legacy build's README documents two CDN urls and one sync command. None of the three resolve to anything today.
The urls
The README names
v0.0.8, which was never released — this build first shipped inv0.1.0. Verified against the CDN:/browser-sdk/v0.0.8/fc-rum-legacy.js/browser-sdk/v0.0.8/flashcat-rum.js/browser-sdk/v0.0.7/fc-rum-legacy.js/browser-sdk/v0.1.0/fc-rum-legacy.js/browser-sdk/v0.1.0/flashcat-rum.js"0.1.0"Replaced with a
<version>placeholder, plus a line saying the build ships fromv0.1.0onwards. A literal version in prose goes stale on the next release, which is how this one got here.The sync command
The example passed
v0.deploy-oss.jsuploads under/browser-sdk/${full version}/only, so nothing writes a rollingv0directory — what sits there is from a much earlier deploy and has nofc-rum-legacy.jsat all. The documented command fails partway.Dropped the arguments: with none, the script takes the version from
lerna.jsonand matches the checkout it runs from. Also noted that the arguments are positional, so an output directory cannot be given without naming a version first — the reason the fix is not simply removingv0from the middle of the line.Verification
node scripts/deploy/sync-bundles.js prod v0.1.0 <dir>— downloads all six files (four entry bundles, two hash-named chunks), exit 0.prod v0.0.7— reports thefc-rum-legacy.js404, leaves the directory named.incomplete, exits 1. The "fails loudly" claim in the README holds.prettier --checkpasses on both files.<script>snippets still finds and passes 2 snippets; no snippet was touched.The
sync-bundles.jsusage comment carried the samev0.0.8example and is updated with it.