Skip to content

docs: add deployhq as a node.js deployment provider#2267

Open
facundofarias wants to merge 3 commits into
nuxt:mainfrom
facundofarias:add-deployhq
Open

docs: add deployhq as a node.js deployment provider#2267
facundofarias wants to merge 3 commits into
nuxt:mainfrom
facundofarias:add-deployhq

Conversation

@facundofarias

Copy link
Copy Markdown

Adds DeployHQ to the deployment provider list at https://nuxt.com/deploy. DeployHQ is a Git-based deployment automation tool that connects to a GitHub/GitLab/Bitbucket repository, runs the Nuxt build on its build pipeline servers, and transfers the resulting .output/ directory to a server you own over SSH/SFTP/FTP — or to S3/Azure Blob/Rackspace Cloud Files. The application then runs under the standard Nitro node-server preset (node .output/server/index.mjs). Multiple environments per project (branch-to-server mapping), encrypted config-file injection, atomic releases with a symlinked current directory, one-click rollback, and pre/post deploy hooks are supported. A free tier is available.

The change mirrors the existing per-provider page format under content/deploy/ — same YAML front matter shape (title, description, logoSrc, category: Hosting, nitroPreset, website), same numbered Setup steps, same ::read-more block at the end. The closest precedent in shape and tone is content/deploy/hostinger.md (added in #2194), which also documents Git-based deployment to a Node.js host using the node-server preset. DeployHQ fills the same gap for users who deploy to their own infrastructure rather than a managed host.

Files

  • content/deploy/deployhq.md (new)
  • public/assets/integrations/deployhq.svg (new, 522 bytes)

Notes

  • Uses nitroPreset: 'node-server' (matches Hostinger / generic Node hosts; no dedicated preset since DeployHQ is a deploy tool, not a runtime).
  • package.json example uses "engines": { "node": ">=20.19" } to match Nuxt 4's supported Node range.
  • The intro includes an explicit ::tip clarifying that DeployHQ delivers the build artifact rather than hosting the running process — pre-empting the most likely reviewer question.

Add a new per-provider page under content/deploy/ documenting how
to deploy a Nuxt application to your own server with DeployHQ.

DeployHQ is a Git-based deployment automation platform: it connects
to a GitHub/GitLab/Bitbucket repository, runs the Nuxt build on its
build pipeline servers, and transfers the .output/ directory to a
user-controlled server over SSH/SFTP/FTP (or to S3, Azure Blob, or
Rackspace Cloud Files). The page uses the standard Nitro node-server
preset, mirroring the precedent set by content/deploy/hostinger.md
(PR nuxt#2194).

Also adds the DeployHQ logo SVG at public/assets/integrations/deployhq.svg.
@facundofarias facundofarias requested a review from atinux as a code owner June 7, 2026 17:38
@vercel

vercel Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

@facundofarias is attempting to deploy a commit to the Nuxt Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9e89fbb-8657-4cd2-949f-96a23ca43b50

📥 Commits

Reviewing files that changed from the base of the PR and between 8ca93ec and 6d0ad3a.

📒 Files selected for processing (1)
  • content/deploy/deployhq.md
✅ Files skipped from review due to trivial changes (1)
  • content/deploy/deployhq.md

📝 Walkthrough

Walkthrough

This PR adds a new DeployHQ deployment documentation page with front-matter metadata, an overview describing Git-based builds and Nitro node-server runtime, step-by-step setup for DeployHQ build pipeline commands, required package.json engines/scripts, instructions for running the long-lived Node process and optional deploy hooks, an alternate static deploy flow using npm run generate, operational tips (env mapping, encrypted config, atomic releases), and links to DeployHQ and Nitro docs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: adding DeployHQ documentation as a Node.js deployment provider.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, explaining what DeployHQ is, how it integrates, and detailing the files added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/deploy/deployhq.md`:
- Line 51: Replace the unhyphenated compound modifier "pre/post deployment
commands" with the grammatically correct "pre-/post-deployment commands" in the
sentence that reads "Optionally use **deploy hooks** (pre/post deployment
commands) to restart your process manager after each release, for example `pm2
reload my-nuxt-app` as a post-deploy SSH command." Locate the line containing
the phrase "pre/post deployment commands" (and the example `pm2 reload
my-nuxt-app`) and update only that phrase to "pre-/post-deployment commands."
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: add02706-cb4a-4412-b672-a398a08d94dc

📥 Commits

Reviewing files that changed from the base of the PR and between 452d2b1 and 8ca93ec.

⛔ Files ignored due to path filters (1)
  • public/assets/integrations/deployhq.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • content/deploy/deployhq.md

Comment thread content/deploy/deployhq.md Outdated
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.

1 participant