@faable/faable 1.24.1 → 1.26.0

package/dist/commands/deploy/index.js

@@ -3,6 +3,7 @@ import { Configuration } from '../../lib/Configuration.js';
 import { log } from '../../log.js';
 import { link } from '../link/index.js';
 import { git_context } from './git_context.js';
+import { propose_release } from './release_version.js';
 import { deploy_remote } from './remote/index.js';
 import { resolve_app_id } from './resolve_app_id.js';
 import { secrets } from './secrets/index.js';
@@ -25,6 +26,10 @@ const deploy = {
             alias: 'w',
             type: 'string',
             description: 'Working directory'
+        })
+            .option('release', {
+            type: 'string',
+            description: 'Release version to record on the deployment (injected as FAABLE_RELEASE). Defaults to FAABLE_RELEASE env or the latest git tag'
         })
             .showHelpOnFail(false);
     },
@@ -47,6 +52,13 @@ const deploy = {
         // Capture the commit/ref/actor so the deployment records which commit
         // it came from and who pushed it (env in CI, git fallback locally).
         const git = await git_context({ workdir });
+        // Propose the release version (--release > FAABLE_RELEASE > git tag).
+        // Optional: when absent the platform injects no FAABLE_RELEASE and the
+        // app falls back to its own version source.
+        const proposed = await propose_release({ workdir, explicit: args.release });
+        if (proposed) {
+            log.info(`🏷️ Release: ${proposed.release} (from ${proposed.source})`);
+        }
         // Remote build only (arch/deploy/remote-artifact-default-cutover.md): the
         // CLI no longer builds — it uploads the source and the platform builds
         // server-side (framework detection, buildpacks, artifact/image output all
@@ -54,7 +66,13 @@ const deploy = {
         // (build_mode=local opt-out, or the global kill-switch off) or a build
         // error throws and exits red.
         log.info(`🚀 Deploying "${app.name}" (${app.id})`);
-        const deployment = await deploy_remote({ api, app, git, workdir });
+        const deployment = await deploy_remote({
+            api,
+            app,
+            git,
+            release: proposed?.release,
+            workdir
+        });
         const dashboard_url = `https://dashboard.faable.com/deploy/${app.team}/app/${app.id}`;
         log.info(`Preparing to deploy in faable cloud · ${deployment.id}`);
         log.info(`📊 View it in the dashboard -> ${dashboard_url}`);

package/dist/commands/deploy/release_version.js

@@ -0,0 +1,53 @@
+import { exec } from 'child_process';
+
+// Quiet git runner, same contract as git_context's: trimmed stdout or
+// undefined on any failure. A deploy must never fail because a release
+// version couldn't be proposed.
+const gitRunner = (workdir) => command => new Promise(resolve => {
+    exec(command, { cwd: workdir }, (err, stdout) => {
+        if (err)
+            return resolve(undefined);
+        const out = stdout?.toString().trim();
+        resolve(out || undefined);
+    });
+});
+// Loose version shape: "starts like semver". Filters out non-version tags
+// (e.g. "nightly", "deploy-2026-07-01") when falling back to git describe;
+// explicit values (--release / FAABLE_RELEASE) are NEVER validated — the
+// platform treats release as free text.
+const looksLikeVersion = (v) => /^\d+\.\d+\.\d+/.test(v);
+const stripV = (tag) => tag.replace(/^v/, "");
+/**
+ * Propose the release version for a deploy (Sentry propose-version pattern):
+ * explicit `--release` > `FAABLE_RELEASE` env > latest reachable git tag
+ * (`v1.2.3` or `1.2.3`, e.g. the tag semantic-release created) > undefined.
+ * When undefined the field is omitted from the deployment and the platform
+ * injects no FAABLE_RELEASE — the app falls back to its own version source.
+ * No SHA fallback: the commit already travels as `github_commit`.
+ */
+const propose_release = async (opts) => {
+    const env = opts?.env ?? process.env;
+    const run = opts?.run ?? gitRunner(opts?.workdir);
+    if (opts?.explicit)
+        return { release: opts.explicit, source: "--release" };
+    if (env.FAABLE_RELEASE)
+        return { release: env.FAABLE_RELEASE, source: "FAABLE_RELEASE env" };
+    // Latest tag reachable from HEAD. Try version-shaped tags first so a
+    // repo that also tags non-releases still resolves; retry unfiltered for
+    // repos whose release tags carry no `v` prefix.
+    for (const cmd of [
+        `git describe --tags --abbrev=0 --match "v[0-9]*"`,
+        `git describe --tags --abbrev=0`,
+    ]) {
+        const tag = await run(cmd);
+        if (!tag)
+            continue;
+        const version = stripV(tag);
+        if (looksLikeVersion(version)) {
+            return { release: version, source: `git tag ${tag}` };
+        }
+    }
+    return undefined;
+};
+
+export { propose_release };

package/dist/commands/deploy/remote/index.js

@@ -15,7 +15,7 @@ import { upload_missing_blobs } from './upload.js';
  * BUILD_ERROR — throws so the command exits red.
  */
 const deploy_remote = async (props) => {
-    const { api, app, git, workdir } = props;
+    const { api, app, git, release, workdir } = props;
     log.info(`☁️ Remote build`);
     const manifest = await collect_manifest(workdir);
     log.info(`🗂️ ${manifest.length} files in the source manifest`);
@@ -25,6 +25,7 @@ const deploy_remote = async (props) => {
     const deployment = await api.createDeployment({
         app_id: app.id,
         source: { manifest },
+        ...(release ? { release } : {}),
         ...git,
     });
     log.info(`Preparing to build in faable cloud · ${deployment.id}`);

package/dist/commands/link/index.js

@@ -3,8 +3,8 @@ import prompts from 'prompts';
 import { log } from '../../log.js';
 import { Configuration } from '../../lib/Configuration.js';
 import { getGitRemoteUrl } from '../../lib/git_remote.js';
-import { workflowExists, DEPLOY_WORKFLOW_PATH, writeWorkflow, DEPLOY_DOCS_URL, DEPLOY_WORKFLOW_YAML } from './workflow_template.js';
 
+const DEPLOY_DOCS_URL = "https://faable.com/docs/deploy/github-actions";
 const link = {
     command: "link",
     describe: "Link the local repository with a Faable app",
@@ -70,8 +70,9 @@ const link = {
         }
         // The API verifies that the user has a connected GitHub identity AND
         // access to the repository before persisting the link.
+        let linked;
         try {
-            await api.linkRepository(selectedApp.id, { repository: gitUrl });
+            linked = await api.linkRepository(selectedApp.id, { repository: gitUrl });
         }
         catch (err) {
             const code = err?.code;
@@ -97,10 +98,17 @@ const link = {
         // Save locally for CLI convenience (only after the API confirms the link)
         Configuration.instance().saveConfig({ app_slug: selectedApp.name, app_id: selectedApp.id });
         log.info(`Successfully linked local repository to ${selectedApp.name}.`);
-        // Onboarding: deploys happen via a GitHub Actions workflow on push. Offer
-        // to scaffold it, and always explain the next steps so the user isn't left
-        // wondering why nothing deploys.
-        await setupDeployWorkflow(workdir);
+        // Deploy v4: push-to-deploy is server-side by default — no workflow to
+        // scaffold. A repo that brings its own Faable workflow keeps deploying
+        // through it (the API leaves the trigger on the Action in that case).
+        const branch = linked?.github_branch || "main";
+        if (linked?.deploy_trigger === "webhook") {
+            log.info(`Push to deploy is on: every push to "${branch}" deploys automatically.`);
+            log.info(`Prefer deploying from your own CI? Docs: ${DEPLOY_DOCS_URL}`);
+        }
+        else {
+            log.info(`This repository has its own Faable deploy workflow — pushes to "${branch}" keep deploying through it. Docs: ${DEPLOY_DOCS_URL}`);
+        }
     },
 };
 // Top-level `faable link` predates the per-product layout (`faable deploy link`).
@@ -115,32 +123,5 @@ const link_deprecated = {
         await link.handler(args);
     }
 };
-const setupDeployWorkflow = async (workdir) => {
-    if (workflowExists(workdir)) {
-        log.info(`Deploy workflow already present at ${DEPLOY_WORKFLOW_PATH}. Commit & push to "main" to deploy.`);
-        return;
-    }
-    const { create } = await prompts({
-        type: "toggle",
-        name: "create",
-        message: `Create the GitHub Actions deploy workflow (${DEPLOY_WORKFLOW_PATH})?`,
-        initial: true,
-        active: "yes",
-        inactive: "no",
-    });
-    if (create) {
-        const filePath = await writeWorkflow(workdir);
-        log.info(`Created ${filePath}`);
-        log.info("Next steps:");
-        log.info("  1. Commit the workflow file");
-        log.info('  2. Push to "main" — that triggers your first deploy');
-        log.info(`Docs: ${DEPLOY_DOCS_URL}`);
-    }
-    else {
-        log.info(`Skipped. To enable automated deploys, add ${DEPLOY_WORKFLOW_PATH} with:`);
-        log.info(`\n${DEPLOY_WORKFLOW_YAML}`);
-        log.info(`Then commit & push to "main". Docs: ${DEPLOY_DOCS_URL}`);
-    }
-};
 
 export { link, link_deprecated };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/faable",
-  "version": "1.24.1",
+  "version": "1.26.0",
   "main": "dist/index.js",
   "license": "MIT",
   "author": "Marc Pomar <marc@faable.com>",

package/dist/commands/link/workflow_template.js

@@ -1,36 +0,0 @@
-import { mkdir, writeFile } from 'fs/promises';
-import { existsSync } from 'fs';
-import { join, dirname } from 'path';
-
-// The canonical GitHub Actions workflow that deploys a Faable app on push.
-// Mirrors the docs at https://faable.com/docs/deploy/github-actions.
-const DEPLOY_WORKFLOW_PATH = ".github/workflows/deploy.yaml";
-const DEPLOY_WORKFLOW_YAML = `name: Deploy to Faable
-on:
-  push:
-    branches:
-      - main
-permissions:
-  id-token: write
-  contents: write
-  pull-requests: write
-  issues: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-node@v6
-      - run: npx @faable/faable@latest deploy
-`;
-const DEPLOY_DOCS_URL = "https://faable.com/docs/deploy/github-actions";
-const workflowExists = (workdir) => existsSync(join(workdir, DEPLOY_WORKFLOW_PATH));
-const writeWorkflow = async (workdir) => {
-    const filePath = join(workdir, DEPLOY_WORKFLOW_PATH);
-    await mkdir(dirname(filePath), { recursive: true });
-    await writeFile(filePath, DEPLOY_WORKFLOW_YAML, "utf8");
-    return filePath;
-};
-
-export { DEPLOY_DOCS_URL, DEPLOY_WORKFLOW_PATH, DEPLOY_WORKFLOW_YAML, workflowExists, writeWorkflow };