chore: improved README.md for build artifacts

CONTINUOUS_BUILD.md

@@ -0,0 +1,57 @@
+# Continuous Build Artifacts
+
+This repo contains build artifacts that are generated as part of the continues build pipeline.
+
+Currently supported artifacts:
+
+- [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build)
+- [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build)
+- [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build)
+
+The build artifact is created if:
+
+- Code is merged to `main` branch
+- Code is merged to `build/*` branch
+
+## How to use
+
+The build artifacts are useful if you want to:
+
+- Install an un-released change.
+- Bisect which specific commit caused a regression.
+
+## Install specific build artifact
+
+To install a specific build artifact change you `package.json` like so (not all lines may be needed):
+
+```json
+{
+  "dependencies": {
+    "@builder.io/qwik": "github:BuilderIO/qwik-build#SHA",
+    "@builder.io/qwik-city": "github:BuilderIO/qwik-city-build#SHA",
+    "@builder.io/qwik-labs": "github:BuilderIO/qwik-labs-build#SHA"
+  }
+}
+```
+
+Where `#SHA` is one of the following:
+
+- `#SHA` - Install a specific build SHA. You can get the SHA from:
+  - [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build/commits/) commits
+  - [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build/commits/) commits
+  - [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build/commits/) commits
+- `#build/name` (or `#main`) - Install a specific `build/*` (or `#main`) branch:
+  - [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build/branches/) branches
+  - [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build/branches/) branches
+  - [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build/branches/) branches
+    > NOTE: Package managers will treat any SHA in the lock file which is on the branch as valid, and so they will not auto upgrade to the latest. For this reason this is not recommended.
+
+## Bisect for regression
+
+You can bisect different commits to `main` to determine which specific change has cause the regression.
+
+1. Install latest to get an upper mound
+2. Install oldest known good to get a lower bound
+3. Keep bisecting until you find a specific SHA where the code breaks.
+
+When creating the issue please include which SHA has caused the regression.

scripts/qwik-save-artifacts.ts

@@ -76,6 +76,7 @@ async function prepare({ buildRepo, artifactsDir }: { buildRepo: string; artifac
     ...(await expand(artifactsDir, ['.gitignore', 'node_modules'])),
     buildRepoDir
   );
+  await $('cp', join(root, 'CONTINUOUS_BUILD.md'), 'README.md');
   await $('git', 'add', '--all');
   await $(
     'git',