feat: gather deployment git meta from the build server #2392
Conversation
This PR adapts the deployment command to also evaluate build server env variables when creating the git meta. The build server will initially only support deployments triggered by the github app, but we might add other git providers in the future. Sticking to the GH actions naming convention for the env variables set by the build server in favor of consistency.
|
Walkthrough
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
packages/cli-v3/src/utilities/gitMeta.ts (1)
117-188: Validate GITHUB_SHA format in getGitHubActionsMetaI searched the repo and found no existing SHA-format validation. Add a small regex check in packages/cli-v3/src/utilities/gitMeta.ts (getGitHubActionsMeta).
- packages/cli-v3/src/utilities/gitMeta.ts — function getGitHubActionsMeta (approx. lines 117–188)
Suggested change:
async function getGitHubActionsMeta(): Promise<GitMeta> { const remoteUrl = process.env.GITHUB_SERVER_URL && process.env.GITHUB_REPOSITORY ? `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}.git` : undefined; // GITHUB_SHA and GITHUB_REF are both set in GH Actions CI const githubSha = process.env.GITHUB_SHA ?? ""; const githubRef = process.env.GITHUB_REF ?? ""; + + // Validate SHA format (40 hex characters) + if (githubSha && !/^[a-f0-9]{40}$/i.test(githubSha)) { + console.debug(`Invalid GITHUB_SHA format: ${githubSha}`); + }
🧹 Nitpick comments (2)
packages/cli-v3/src/utilities/gitMeta.ts (2)
154-159: Remove or improve debug logging.The git status debug output at line 154-159 appears to be leftover debugging code that may not be necessary in production.
- await x("git", ["status"], { - nodeOptions: { - cwd: process.cwd(), - }, - }).then((result) => console.debug(result.stdout));
220-268: Consider potential performance impact of git operations.The
getCommitMessagefunction performs multiple git operations that could fail or be slow, especially when fetching from remote. Consider adding timeouts and better error handling.Consider implementing a timeout mechanism for git operations to prevent hanging:
async function getCommitMessage( directory: string, sha: string, prNumber?: number ): Promise<string | undefined> { + const GIT_TIMEOUT_MS = 30000; // 30 seconds + try { // First try to fetch the specific commit - await x("git", ["fetch", "origin", sha], { + const fetchPromise = x("git", ["fetch", "origin", sha], { nodeOptions: { cwd: directory, }, }); + + // Add timeout + await Promise.race([ + fetchPromise, + new Promise((_, reject) => + setTimeout(() => reject(new Error('Git fetch timeout')), GIT_TIMEOUT_MS) + ) + ]);Additionally, consider caching the results to avoid repeated fetches for the same SHA.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/cli-v3/src/utilities/gitMeta.ts(5 hunks)packages/core/src/v3/schemas/common.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)
**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations
Files:
packages/core/src/v3/schemas/common.tspackages/cli-v3/src/utilities/gitMeta.ts
{packages/core,apps/webapp}/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)
We use zod a lot in packages/core and in the webapp
Files:
packages/core/src/v3/schemas/common.ts
🧬 Code Graph Analysis (1)
packages/cli-v3/src/utilities/gitMeta.ts (1)
packages/core/src/v3/schemas/common.ts (2)
GitMeta(239-253)GitMeta(255-255)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (23)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
packages/core/src/v3/schemas/common.ts (1)
238-243: LGTM! Well-structured GitMeta schema extensions.The new optional fields are appropriately typed and maintain backward compatibility. The comment clearly explains why these fields are optional.
packages/cli-v3/src/utilities/gitMeta.ts (2)
8-15: LGTM! Clear prioritization of metadata sources.The metadata source resolution order (GitHub App → GitHub Actions → local) is well-structured and aligns with the PR objectives.
108-115: Good improvement on GitHub Actions detection.The additional checks for
GITHUB_SHAandGITHUB_REFmake the detection more robust and prevent false positives.
This PR adapts the deployment command to also evaluate build server env
variables when creating the git meta. The build server will initially
only support deployments triggered by the github app, but we might add
other git providers in the future.
Sticking to the GH actions naming convention for the env variables set
by the build server in favor of consistency.