diff --git a/.CHANGELOG.md.swp b/.CHANGELOG.md.swp deleted file mode 100644 index 8a7380416a..0000000000 Binary files a/.CHANGELOG.md.swp and /dev/null differ diff --git a/.gitignore b/.gitignore index 2030a510f3..89d6ac70ff 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,6 @@ package.tgz .VSCodeCounter .env .vscode + +# Editor swap files +*.swp diff --git a/README.md b/README.md index a9a3134af2..53b2eb77d2 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,16 @@ This repository contains several packages: ## CDN bundle -https://static.flashcat.cloud/browser-sdk/v0/flashcat-rum.js +``` +https://static.flashcat.cloud/browser-sdk//flashcat-rum.js +``` + +`` is the release tag, `v` prefix included. The [SDK versions page][versions] is where to +look the current one up. Each release gets its own directory and earlier ones are never rewritten, +so a url serves the version it names. + +The earlier `/browser-sdk/v0/` path, named for the major version rather than the release, is no +longer updated. It still resolves, but stays at the release it last held. ## License Information @@ -31,6 +40,7 @@ This project is modified and distributed by flashcat under the Apache License 2. For complete license information, please refer to the [LICENSE](./LICENSE) file. +[versions]: https://docs.flashcat.cloud/en/rum/sdk/versions [18]: https://docs.flashcat.cloud/zh/flashduty/rum/introduction [01]: https://badge.fury.io/js/%40flashcatcloud%2Fbrowser-logs.svg [02]: https://badge.fury.io/js/%40flashcatcloud%2Fbrowser-logs diff --git a/packages/rum-legacy/README.md b/packages/rum-legacy/README.md index c175e2fca1..e2e0886aa3 100644 --- a/packages/rum-legacy/README.md +++ b/packages/rum-legacy/README.md @@ -45,10 +45,14 @@ names, which those engines cannot even parse and no runtime guard could catch. Released bundles are served from the CDN under the directory of the release they belong to: ``` -https://static.flashcat.cloud/browser-sdk/v0.0.8/fc-rum-legacy.js -https://static.flashcat.cloud/browser-sdk/v0.0.8/flashcat-rum.js +https://static.flashcat.cloud/browser-sdk//fc-rum-legacy.js +https://static.flashcat.cloud/browser-sdk//flashcat-rum.js ``` +`` is the release tag, `v` prefix included. The [SDK versions page](https://docs.flashcat.cloud/en/rum/sdk/versions) is where to +look the current one up. This build ships from `v0.1.0` onwards; the directories of earlier +releases exist but hold no `fc-rum-legacy.js`. + Each release gets its own directory and earlier ones are left as they were, so a url pins the version it names. Updating a self-hosted copy means pointing at the next release, not re-downloading the same url. @@ -59,11 +63,17 @@ chunk files that must match it exactly. `scripts/deploy/sync-bundles.js` downloa coherent set instead: ```bash -node scripts/deploy/sync-bundles.js prod v0 ./cdn-bundles +node scripts/deploy/sync-bundles.js ``` -It needs no credentials, fails loudly if any file is missing, and the resulting directory is served -as-is from the hosting origin — the `` in the snippet below. +Run from the checkout of the release being deployed: with no arguments it takes the version from +`lerna.json`, so the set it downloads matches the source it was run from and no version has to be +typed out. Its arguments are positional — `[env] [version] [outputDir]` — and naming an output +directory means naming the version before it. + +It needs no credentials, fails loudly if any file is missing, and the resulting directory +(`./cdn-bundles`) is served as-is from the hosting origin — the `` in the snippet +below. ## Setup diff --git a/scripts/deploy/sync-bundles.js b/scripts/deploy/sync-bundles.js index de254bfd1a..6446907da2 100644 --- a/scripts/deploy/sync-bundles.js +++ b/scripts/deploy/sync-bundles.js @@ -29,7 +29,7 @@ const ENTRY_BUNDLES = ['flashcat-logs.js', 'flashcat-rum.js', 'flashcat-rum-slim * Usage: * node sync-bundles.js [env] [version] [outputDir] * env = prod|staging, defaults to prod - * version = the release directory, ex: v0.0.8. Defaults to the version in lerna.json + * version = the release directory, ex: v0.1.0. Defaults to the version in lerna.json * outputDir = defaults to ./cdn-bundles * * The script needs no credentials: it downloads over plain HTTPS from the same URLs a page would