feat: support NETLIFY_DB_BRANCH env var in db status command

[eduardoboucas]

Follow-up to #8173.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• New Features

  • Added support for configuring the remote database branch via the NETLIFY_DB_BRANCH environment variable
  • CLI flag --branch takes precedence when both the environment variable and flag are set
  • Updated error messaging for remote branch targeting

• Tests

  • Added comprehensive tests for environment variable behavior and CLI flag precedence

Walkthrough

This pull request adds support for specifying the remote database branch via the NETLIFY_DB_BRANCH environment variable in the statusDb command. The implementation introduces a derived branch variable that defaults to options.branch but falls back to the environment variable when the CLI flag is not provided. This branch variable is then used throughout the function for fetching the connection string, retrieving applied migrations, and displaying branch information. Corresponding unit tests verify that the environment variable is properly used and that the CLI flag takes precedence when both are supplied.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding support for the NETLIFY_DB_BRANCH environment variable in the db status command, which matches the changeset.
Description check	✅ Passed	The description references a follow-up to PR #8173, which provides context that relates to the changeset, though minimal detail is given.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/db-status-env

---

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

[github-actions]

📊 Benchmark results

Comparing with 9bccaf9

• Dependency count: 1,061 (no change)
• Package size: 355 MB ⬆️ 0.00% increase vs. 9bccaf9
• Number of ts-expect-error directives: 356 (no change)

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/commands/database/status-db.ts`:
- Around line 364-365: Remove the explanatory inline comment that duplicates
behavior for branch resolution; delete the comment line preceding the
declaration so the code reads simply as const branch = options.branch ??
process.env.NETLIFY_DB_BRANCH (no comment needed). Locate the comment that says
"`--branch` can also be supplied via the NETLIFY_DB_BRANCH env var." immediately
above the branch assignment and remove it, leaving the assignment as the
self-explanatory implementation.

🪄 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: 35ab0acf-12c5-4eee-b4f9-d2005e010900

📥 Commits

Reviewing files that changed from the base of the PR and between 9bccaf9 and 52d375f.

📒 Files selected for processing (2)

• src/commands/database/status-db.ts
• tests/unit/commands/database/status-db.test.ts

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Remove explanatory inline behavior comment.

Line 364-365 documents what the code does; this should be expressed by code only.

Suggested cleanup

-  // `--branch` can also be supplied via the NETLIFY_DB_BRANCH env var.
   const branch = options.branch ?? process.env.NETLIFY_DB_BRANCH

As per coding guidelines, **/*.{ts,tsx,js,jsx}: Never write comments on what the code does; make the code clean and self-explanatory instead.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	// `--branch` can also be supplied via the NETLIFY_DB_BRANCH env var.
	const branch = options.branch ?? process.env.NETLIFY_DB_BRANCH
	const branch = options.branch ?? process.env.NETLIFY_DB_BRANCH

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/commands/database/status-db.ts` around lines 364 - 365, Remove the
explanatory inline comment that duplicates behavior for branch resolution;
delete the comment line preceding the declaration so the code reads simply as
const branch = options.branch ?? process.env.NETLIFY_DB_BRANCH (no comment
needed). Locate the comment that says "`--branch` can also be supplied via the
NETLIFY_DB_BRANCH env var." immediately above the branch assignment and remove
it, leaving the assignment as the self-explanatory implementation.