✨ Add cloud ci setup command

Shortcake-Parent: main

Author: patrick91

src/fastapi_cloud_cli/commands/ci/__init__.py

@@ -3,11 +3,13 @@
 from fastapi_cloud_cli.commands.ci.print_workflow import (
     print_workflow as print_workflow_command,
 )
+from fastapi_cloud_cli.commands.setup_ci import setup_ci
 
 ci_app = typer.Typer(
     no_args_is_help=True,
     help="Manage CI integration helpers.",
 )
 ci_app.command("print-workflow")(print_workflow_command)
+ci_app.command("setup")(setup_ci)
 
 __all__ = ["ci_app"]

src/fastapi_cloud_cli/commands/setup_ci.py

@@ -2,22 +2,51 @@
 import re
 import shutil
 import subprocess
+from datetime import datetime, timezone
 from pathlib import Path
-from typing import Annotated
+from typing import Annotated, Any
 
 import typer
+from pydantic import BaseModel
 
 from fastapi_cloud_cli.utils.api import APIClient
 from fastapi_cloud_cli.utils.apps import resolve_app_id_or_fail
 from fastapi_cloud_cli.utils.auth import Identity
-from fastapi_cloud_cli.utils.cli import get_rich_toolkit
+from fastapi_cloud_cli.utils.cli import FastAPIRichToolkit, get_rich_toolkit
+from fastapi_cloud_cli.utils.execution import JsonOutputOption
 
 logger = logging.getLogger(__name__)
 
 TOKEN_EXPIRES_DAYS = 365
 DEFAULT_WORKFLOW_PATH = Path(".github/workflows/deploy.yml")
 
 
+class CISetupOutput(BaseModel):
+    app_id: str
+    repo: str
+    branch: str
+    workflow_path: str
+    created_token: bool
+    set_github_secrets: bool
+    wrote_workflow: bool
+    token_expired_at: str | None = None
+
+
+def _render_ci_setup_output(data: CISetupOutput, toolkit: FastAPIRichToolkit) -> None:
+    toolkit.print("Done — commit and push to start deploying.", emoji="✅")
+
+    if data.token_expired_at:
+        toolkit.print_line()
+        toolkit.print(
+            f"Your deploy token expires on [bold]{data.token_expired_at[:10]}[/bold]. "
+            "Regenerate it from the dashboard or re-run this command before then.",
+        )
+
+
+def _render_noop_output(_data: CISetupOutput, _toolkit: FastAPIRichToolkit) -> None:
+    pass
+
+
 class GitHubSecretError(Exception):
     """Raised when setting a GitHub Actions secret fails."""
 
@@ -157,6 +186,44 @@ def _write_workflow_file(branch: str, workflow_path: Path) -> None:
     workflow_path.write_text(workflow_content)
 
 
+def _get_workflow_path(file: str | None) -> Path:
+    if file:
+        return Path(f".github/workflows/{file}")
+
+    return DEFAULT_WORKFLOW_PATH
+
+
+def _resolve_existing_workflow_path(
+    toolkit: FastAPIRichToolkit, workflow_path: Path
+) -> Path | None:
+    if toolkit.mode == "json":
+        toolkit.fail(
+            "invalid_input",
+            f"Workflow file {workflow_path} already exists.",
+            hint="Pass --file to choose another workflow file or remove the existing file.",
+        )
+
+    overwrite = toolkit.confirm(
+        f"Workflow file [bold]{workflow_path}[/bold] already exists. Overwrite?",
+        default=False,
+    )
+    if overwrite:
+        toolkit.print_line()
+        return workflow_path
+
+    new_name = toolkit.input(
+        "Enter a new filename (without path) or leave blank to skip writing the workflow file:",
+    ).strip()
+    if new_name:
+        toolkit.print_line()
+        return Path(f".github/workflows/{new_name}")
+
+    toolkit.print("Skipped writing workflow file.")
+    toolkit.print_line()
+    toolkit.print_line()
+    return None
+
+
 def setup_ci(
     path: Annotated[
         Path | None,
@@ -185,6 +252,12 @@ def setup_ci(
         help="Provisions token and sets secrets, skips writing the workflow file",
         show_default=True,
     ),
+    workflow_only: bool = typer.Option(
+        False,
+        "--workflow-only",
+        help="Writes the workflow file without creating a token or setting secrets",
+        show_default=True,
+    ),
     dry_run: bool = typer.Option(
         False,
         "--dry-run",
@@ -198,25 +271,34 @@ def setup_ci(
         "-f",
         help="Custom workflow filename (written to .github/workflows/)",
     ),
-) -> None:
+    json_output: JsonOutputOption = False,
+) -> Any:
     """Configures a GitHub Actions workflow for deploying the app on push to the specified branch.
 
     Examples:
         fastapi cloud setup-ci                      # Provisions token, sets secrets, and writes workflow file for the 'main' branch
         fastapi cloud setup-ci --branch develop     # Same as above but for the 'develop' branch
         fastapi cloud setup-ci --secrets-only       # Only provisions token and sets secrets, does not write workflow file
+        fastapi cloud setup-ci --workflow-only      # Only writes the workflow file
         fastapi cloud setup-ci --dry-run            # Prints the steps that would be taken without performing them
         fastapi cloud setup-ci --file ci.yml        # Writes workflow to .github/workflows/ci.yml
     """
 
     identity = Identity()
 
-    with get_rich_toolkit() as toolkit:
+    with get_rich_toolkit(json_output=json_output) as toolkit:
         if not identity.is_logged_in():
-            toolkit.print(
-                "No credentials found. Use [blue]`fastapi login`[/] to login.",
+            toolkit.fail(
+                "not_logged_in",
+                "No credentials found.",
+                hint="Run `fastapi cloud login` or set FASTAPI_CLOUD_TOKEN.",
+            )
+
+        if secrets_only and workflow_only:
+            toolkit.fail(
+                "invalid_input",
+                "--secrets-only and --workflow-only cannot be used together.",
             )
-            raise typer.Exit(1)
 
         target_app_id = resolve_app_id_or_fail(
             toolkit,
@@ -247,12 +329,21 @@ def setup_ci(
             )
 
         repo_slug = _repo_slug_from_origin(origin) or origin
-        github_host = _get_github_host(origin)
-        has_gh = _check_gh_cli_installed()
 
         if not branch:
             branch = _get_default_branch()
 
+        workflow_path = _get_workflow_path(file)
+        needs_secrets = not workflow_only
+        needs_workflow = not secrets_only
+
+        if needs_secrets and not dry_run and not _check_gh_cli_installed():
+            toolkit.fail(
+                "dependency_missing",
+                "GitHub CLI (`gh`) is required to set GitHub Actions secrets.",
+                hint="Install gh or use --workflow-only to write only the workflow file.",
+            )
+
         if dry_run:
             toolkit.print(
                 "[yellow]This is a dry run — no changes will be made[/yellow]"
@@ -267,104 +358,104 @@ def setup_ci(
 
         msg_token = "Created deploy token"
         msg_secrets = (
-            "Set [bold]FASTAPI_CLOUD_TOKEN[/bold] and [bold]FASTAPI_CLOUD_APP_ID[/bold]"
-        )
-        workflow_file = file or DEFAULT_WORKFLOW_PATH.name
-        msg_workflow = (
-            f"Wrote [bold].github/workflows/{workflow_file}[/bold] (branch: {branch})"
+            "Set GitHub Actions secrets [bold]FASTAPI_CLOUD_TOKEN[/bold] "
+            "and [bold]FASTAPI_CLOUD_APP_ID[/bold]"
         )
-        msg_done = "Done — commit and push to start deploying."
+        msg_workflow = f"Wrote [bold]{workflow_path}[/bold] (branch: {branch})"
 
         if dry_run:
-            toolkit.print(msg_token)
-            toolkit.print(msg_secrets)
-            if not secrets_only:
+            if needs_secrets:
+                toolkit.print(msg_token)
+                toolkit.print(msg_secrets)
+            if needs_workflow:
                 toolkit.print(msg_workflow)
+            toolkit.success(
+                CISetupOutput(
+                    app_id=target_app_id,
+                    repo=repo_slug,
+                    branch=branch,
+                    workflow_path=str(workflow_path),
+                    created_token=False,
+                    set_github_secrets=False,
+                    wrote_workflow=False,
+                ),
+                render_output=_render_noop_output,
+            )
             return
 
-        from datetime import datetime, timezone
-
-        # Create unique token name with timestamp to avoid duplicates
-        timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC")
-        token_name = f"GitHub Actions — {repo_slug} ({timestamp})"
-
-        with (
-            APIClient() as client,
-            toolkit.progress(
-                title="Generating deploy token...", done_emoji="🔑"
-            ) as progress,
-            client.handle_http_errors(
-                progress, default_message="Error creating deploy token."
-            ),
-        ):
-            token_data = _create_token(
-                client=client, app_id=target_app_id, token_name=token_name
-            )
-            progress.log(msg_token)
+        token_expired_at: str | None = None
+        created_token = False
+        set_github_secrets = False
+        wrote_workflow = False
+
+        if needs_secrets:
+            # Create unique token name with timestamp to avoid duplicates
+            timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC")
+            token_name = f"GitHub Actions — {repo_slug} ({timestamp})"
+
+            with (
+                APIClient() as client,
+                toolkit.progress(
+                    title="Generating deploy token...", done_emoji="🔑"
+                ) as progress,
+                client.handle_http_errors(
+                    progress, default_message="Error creating deploy token."
+                ),
+            ):
+                token_data = _create_token(
+                    client=client, app_id=target_app_id, token_name=token_name
+                )
+                token_expired_at = token_data["expired_at"]
+                created_token = True
+                progress.log(msg_token)
 
-        toolkit.print_line()
+            toolkit.print_line()
 
-        if has_gh:
             with toolkit.progress(
                 title="Setting repo secrets...", done_emoji="🔒"
             ) as progress:
                 try:
                     _set_github_secret("FASTAPI_CLOUD_TOKEN", token_data["value"])
                     _set_github_secret("FASTAPI_CLOUD_APP_ID", target_app_id)
+                    progress.log(msg_secrets)
                 except GitHubSecretError:
                     progress.set_error("Failed to set GitHub secrets via gh CLI.")
-                    raise typer.Exit(1) from None
-                progress.log(msg_secrets)
-        else:
-            secrets_url = f"https://{github_host}/{repo_slug}/settings/secrets/actions"
-            toolkit.print(
-                "[yellow]gh CLI not found. Set these secrets manually:[/yellow]",
-            )
-            toolkit.print_line()
-            toolkit.print(f"  Repository: [blue]{secrets_url}[/]")
-            toolkit.print_line()
-            toolkit.print(f"  [bold]FASTAPI_CLOUD_TOKEN[/bold] = {token_data['value']}")
-            toolkit.print(f"  [bold]FASTAPI_CLOUD_APP_ID[/bold] = {target_app_id}")
+                    toolkit.fail(
+                        "api_error",
+                        "Failed to set GitHub secrets via gh CLI.",
+                    )
+                set_github_secrets = True
 
         toolkit.print_line()
 
-        if not secrets_only:
-            if file:
-                workflow_path = Path(f".github/workflows/{file}")
-            else:
-                workflow_path = DEFAULT_WORKFLOW_PATH
-
-            write_workflow = True
+        if needs_workflow:
+            workflow_path_to_write: Path | None = workflow_path
             if not file and workflow_path.exists():
-                overwrite = toolkit.confirm(
-                    f"Workflow file [bold]{workflow_path}[/bold] already exists. Overwrite?",
-                    default=False,
+                workflow_path_to_write = _resolve_existing_workflow_path(
+                    toolkit, workflow_path
                 )
-                if not overwrite:
-                    new_name = toolkit.input(
-                        "Enter a new filename (without path) or leave blank to skip writing the workflow file:",
-                    ).strip()
-                    if new_name:
-                        workflow_path = Path(f".github/workflows/{new_name}")
-                    else:
-                        toolkit.print("Skipped writing workflow file.")
-                        toolkit.print_line()
-                        write_workflow = False
-                toolkit.print_line()
-            if write_workflow:
+
+            if workflow_path_to_write is not None:
+                workflow_path = workflow_path_to_write
                 msg_workflow = f"Wrote [bold]{workflow_path}[/bold] (branch: {branch})"
                 with toolkit.progress(
                     title="Writing workflow file...", done_emoji="📄"
                 ) as progress:
                     _write_workflow_file(branch, workflow_path)
+                    wrote_workflow = True
                     progress.log(msg_workflow)
 
                 toolkit.print_line()
 
-        toolkit.print(msg_done, emoji="✅")
-        toolkit.print_line()
-        # Token expiration date is in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ), extract date portion
-        toolkit.print(
-            f"Your deploy token expires on [bold]{token_data['expired_at'][:10]}[/bold]. "
-            "Regenerate it from the dashboard or re-run this command before then.",
+        output = CISetupOutput(
+            app_id=target_app_id,
+            repo=repo_slug,
+            branch=branch,
+            workflow_path=str(workflow_path),
+            created_token=created_token,
+            set_github_secrets=set_github_secrets,
+            wrote_workflow=wrote_workflow,
+            token_expired_at=token_expired_at,
         )
+
+        toolkit.success(output, render_output=_render_ci_setup_output)

src/fastapi_cloud_cli/utils/errors.py

@@ -4,6 +4,7 @@
     "already_linked",
     "api_error",
     "cancelled",
+    "dependency_missing",
     "invalid_token",
     "invalid_input",
     "missing_required_input",