Add orchestration_id to git user-agent when ACTIONS_ORCHESTRATION_ID is set (#2355)

* Initial plan * Add orchestration ID support to git user-agent Co-authored-by: TingluoHuang <[email protected]> * Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]> * Improve tests to verify user-agent content and handle empty sanitized IDs Co-authored-by: TingluoHuang <[email protected]> * Simplify orchestration ID validation to accept any non-empty sanitized value Co-authored-by: TingluoHuang <[email protected]> * Remove test for orchestration ID with only invalid characters Co-authored-by: TingluoHuang <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: TingluoHuang <[email protected]> Co-authored-by: Tingluo Huang <[email protected]> Co-authored-by: Copilot <[email protected]>
2026-01-08 15:07:38 -05:00
parent 8e8c483db8
commit 064fe7f331
3 changed files with 141 additions and 2 deletions
@@ -730,7 +730,19 @@ class GitCommandManager {
      }
    }
    // Set the user agent
-    const gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`
+    let gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`
+
+    // Append orchestration ID if set
+    const orchId = process.env['ACTIONS_ORCHESTRATION_ID']
+    if (orchId) {
+      // Sanitize the orchestration ID to ensure it contains only valid characters
+      // Valid characters: 0-9, a-z, _, -, .
+      const sanitizedId = orchId.replace(/[^a-z0-9_.-]/gi, '_')
+      if (sanitizedId) {
+        gitHttpUserAgent = `${gitHttpUserAgent} actions_orchestration_id/${sanitizedId}`
+      }
+    }
+
    core.debug(`Set git useragent to: ${gitHttpUserAgent}`)
    this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent
  }