mechanica 2.1.0-beta.6 → 2.1.0-beta.7

package/README.md

@@ -361,7 +361,7 @@ These drive a locally installed Chrome or Edge (or `--browser <path>`) and need
 | `mechanica images` | Generate image dimensions and blur-up previews for `.mech/assets` (needs `sharp`; `--force` redoes all) |
 | `mechanica login` | Sign in to the Mechanica platform and save an access token for this machine (`--host`, `--token`) |
 | `mechanica link <slug>` | Point this repository at a site on the platform (`--create` makes the site); uploads are then kept by the platform, so `.mech/assets/` goes into `.gitignore` |
-| `mechanica push` | Publish the committed project to the platform: pull what was edited online, send the uploads it lacks, `git push`, build and upload the bundle when the code changed, wait for the deploy |
+| `mechanica push` | Publish the committed project to the platform: pull what was edited online, send the uploads it lacks, `git push`, build and upload the bundle when the code changed, wait for the deploy. It pushes the branch that is checked out, under its own name: the first branch a site is pushed is the site itself, any other is deployed to an address of its own (`<slug>--<branch>`) with its own online editor — a branch name is lowercase letters, digits and single hyphens |
 | `mechanica assets pull` | Download the uploads made in the platform's online editor that this project lacks (the dev server fetches them one by one on demand) |
 
 ## Plugin options

package/dist/cli.js

@@ -428,7 +428,20 @@ var POLL_MS = 1e3;
 var DEPLOY_TIMEOUT_MS = 3e5;
 var AUTO_DEPLOY_WAIT_MS = 1e4;
 /**
-* `mechanica push`: publish the committed project to the platform.
+* Why a branch cannot be pushed under its name, or null when it can. On the platform a branch
+* is served at an address of its own (`<slug>--<branch>`), so its name must be able to be part
+* of one: lowercase letters, digits and single hyphens. The platform checks the same (and how
+* long the name may be for the site) — this only says it before anything is sent.
+*/
+function branchProblem(name) {
+	if (!/^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(name) || name.length > 40 || name.includes("--") || name === "edit") return `The branch "${name}" cannot be pushed under this name: on the platform a branch's name becomes part of its address, so it is up to 40 lowercase letters, digits and single hyphens (and not "edit"). Rename it — \`git branch -m new-name\` — and push again.`;
+	return null;
+}
+/**
+* `mechanica push`: publish the committed project to the platform — the branch that is checked
+* out, under its own name. The first branch a site is pushed becomes the site itself; any
+* other is deployed to an address of its own, with its own online editor, and never touches
+* the site.
 *
 *   1. bring in what was published online since the last pull (`pull --rebase`),
 *   2. send the uploads the platform lacks (they are not in git), then `git push`
@@ -463,18 +476,30 @@ async function runPush() {
 	])).code !== 0) throw new Error("Nothing to push yet — commit your project first");
 	const dirty = await gitOk(cwd, ["status", "--porcelain"]);
 	if (dirty) throw new Error(`Commit or stash your changes first — the working tree is not clean:\n${dirty}`);
+	const current = await git(cwd, [
+		"symbolic-ref",
+		"--quiet",
+		"--short",
+		"HEAD"
+	]);
+	if (current.code !== 0 || !current.stdout) throw new Error("No branch is checked out (a detached HEAD) — switch to the branch you want to push");
+	const branch = current.stdout;
+	const problem = branchProblem(branch);
+	if (problem) throw new Error(problem);
+	const ref = `refs/heads/${branch}`;
+	const query = `?branch=${encodeURIComponent(branch)}`;
 	if (await gitOk(cwd, [
 		"ls-remote",
 		"--heads",
 		"mechanica",
-		"main"
+		ref
 	], auth)) {
 		console.info("Pulling changes from the platform…");
 		const pulled = await git(cwd, [
 			"pull",
 			"--rebase",
 			REMOTE_NAME,
-			"main"
+			branch
 		], auth);
 		if (pulled.code !== 0) throw new Error(`Could not rebase onto the platform's changes:\n${pulled.stderr || pulled.stdout}\nResolve the conflict (\`git rebase --continue\`), then run \`mechanica push\` again.`);
 	}
@@ -484,14 +509,14 @@ async function runPush() {
 		token
 	});
 	const head = await gitOk(cwd, ["rev-parse", "HEAD"]);
-	console.info(`Pushing ${head.slice(0, 8)} to ${link.slug}…`);
+	console.info(`Pushing ${head.slice(0, 8)} to ${link.slug} (${branch})…`);
 	const pushed = await git(cwd, [
 		"push",
 		REMOTE_NAME,
-		"HEAD:refs/heads/main"
+		`HEAD:${ref}`
 	], auth);
 	if (pushed.code !== 0) throw new Error(`git push failed:\n${pushed.stderr || pushed.stdout}`);
-	const statusPath = `/api/sites/${site.uuid}/status`;
+	const statusPath = `/api/sites/${site.uuid}/status${query}`;
 	let status = await request(link.origin, "GET", statusPath, { token });
 	let deployId = null;
 	if (status.needsBundle) {
@@ -501,7 +526,7 @@ async function runPush() {
 			engine: engineVersion()
 		});
 		console.info(`Uploading the bundle (${(body.length / 1024 / 1024).toFixed(1)} MB)…`);
-		const uploaded = await request(link.origin, "POST", `/api/sites/${site.uuid}/bundles`, {
+		const uploaded = await request(link.origin, "POST", `/api/sites/${site.uuid}/bundles${query}`, {
 			token,
 			raw: body
 		});
@@ -531,7 +556,7 @@ async function runPush() {
 		if (deploy.log) console.error(`\n${deploy.log}\n`);
 		throw new Error(`Deploy failed: ${deploy.error ?? "unknown error"}. The previous version stays live.`);
 	}
-	console.info(`\nLive at ${deploy.url ?? status.url} — ${deploy.pages} page(s)`);
+	console.info(`\n${branch} is live at ${deploy.url ?? status.url} — ${deploy.pages} page(s)`);
 }
 //#endregion
 //#region src/cli/headless.ts
@@ -1218,7 +1243,9 @@ Usage:
                             (--create makes the site, --name "Site name")
   mechanica push            Publish the committed project: pull what was edited
                             online, git push, build + upload the bundle when the
-                            code changed, and wait for the deploy
+                            code changed, and wait for the deploy. Pushes the
+                            branch that is checked out: the first one pushed is
+                            the site, any other gets an address of its own
   mechanica shot <blockId>  Screenshot one block via the dev preview route
   mechanica shot </path>    Screenshot a whole page (editor overlay stripped)
                             (--page </path>, --data <json|@file>, --width 1440,768,

package/dist/types/cli/platform/push.d.ts

@@ -1,5 +1,15 @@
 /**
- * `mechanica push`: publish the committed project to the platform.
+ * Why a branch cannot be pushed under its name, or null when it can. On the platform a branch
+ * is served at an address of its own (`<slug>--<branch>`), so its name must be able to be part
+ * of one: lowercase letters, digits and single hyphens. The platform checks the same (and how
+ * long the name may be for the site) — this only says it before anything is sent.
+ */
+export declare function branchProblem(name: string): string | null;
+/**
+ * `mechanica push`: publish the committed project to the platform — the branch that is checked
+ * out, under its own name. The first branch a site is pushed becomes the site itself; any
+ * other is deployed to an address of its own, with its own online editor, and never touches
+ * the site.
  *
  *   1. bring in what was published online since the last pull (`pull --rebase`),
  *   2. send the uploads the platform lacks (they are not in git), then `git push`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mechanica",
-  "version": "2.1.0-beta.6",
+  "version": "2.1.0-beta.7",
   "description": "Build Vue 3 websites with a visual block editor",
   "license": "MIT",
   "repository": {
@@ -66,7 +66,7 @@
     "prepublishOnly": "bun ../../scripts/ensure-bun-publish.js && bun run build"
   },
   "dependencies": {
-    "mechanica-shared": "2.1.0-beta.6",
+    "mechanica-shared": "2.1.0-beta.7",
     "@vue/compiler-sfc": "^3.5.38",
     "compact-json-schema": "^0.1.5",
     "estree-walker": "^3.0.3",