Skip to content

Add step templates for Convex backend deployments#1687

Open
itsmebenwalker wants to merge 4 commits into
OctopusDeploy:masterfrom
itsmebenwalker:bw/convex-steps
Open

Add step templates for Convex backend deployments#1687
itsmebenwalker wants to merge 4 commits into
OctopusDeploy:masterfrom
itsmebenwalker:bw/convex-steps

Conversation

@itsmebenwalker
Copy link
Copy Markdown
Contributor

@itsmebenwalker itsmebenwalker commented May 29, 2026

Summary

This PR adds five new step templates for Convex, a full-stack backend platform built around a serverless TypeScript runtime with a real-time reactive database.

What is Convex?

Convex is a backend-as-a-service platform that replaces a traditional database + API layer with a single, type-safe TypeScript runtime. It provides:

  • Reactive queries - clients automatically receive live updates when data changes, without polling or websockets you manage yourself
  • Serverless functions - mutations, actions, and queries run in Convex's cloud with ACID transactions and automatic scaling
  • Built-in scheduling, file storage, and HTTP actions - a single platform for most backend needs
  • Zero-infrastructure deployments - npx convex deploy pushes your schema and functions in seconds

Convex has become a go-to backend for the AI-native development wave. It's deeply integrated with tools like Cursor, Bolt, and v0, and is a favourite among vibe coders - developers who lean on AI assistants to scaffold and ship full-stack apps fast. Convex's fully TypeScript schema, auto-generated types, and instant deployments make it particularly well-suited to AI-assisted workflows where the goal is to go from idea to production with minimal friction. As AI-generated codebases grow in popularity, Convex is increasingly the backend of choice behind them.

Steps added

Step Purpose
Convex - Deploy Deploys backend functions and schema to a target deployment (production, preview, or named) via a deploy key
Convex - Set Environment Variables Pushes KEY=VALUE environment variables from Octopus into the Convex runtime environment
Convex - Export Data Snapshots deployment data to a local file before a deploy - optionally captured as an Octopus build artifact
Convex - Run Function Invokes a mutation, action, or query - useful for post-deploy migrations, seed data, or smoke-test queries
Convex - Smoke Test HTTP Action HTTP health check against a Convex HTTP action endpoint, validating status code and optionally asserting on the response body

All steps require Node.js and npx on the worker. No additional global installs needed - the Convex CLI is invoked via npx.

Other changes

  • Supabase - Run Migrations: Fixed the Database Migrations Guide documentation link to point to the correct URL.

Testing

Steps were tested end-to-end using a public test repository: https://github.com/itsmebenwalker/octopus-community-step-temp-convex

Screenshots of each completed deployment step are attached below, along with a raw execution log and screenshots from within the Convex dashboard.

image

All steps (completed):

image

Task log:

ServerTasks-1908.log.txt

Each step output:

  • Convex - Set Environment Variables
image image
  • Convex - Export Data
image image
  • Convex - Deploy
image image
  • Convex - Run Function
image image
  • Convex - Smoke Test HTTP Action
image image

@github-actions
Copy link
Copy Markdown

Review this PR in Hyponome for a side-by-side diff of the step-template JSON and any embedded scripts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants