Skip to content

Add ACTIONS_ORCHESTRATION_ID to user-agent string #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TingluoHuang merged 12 commits into from
Jan 7, 2026
+39 −3
Merged

Add ACTIONS_ORCHESTRATION_ID to user-agent string #695

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6599b48
Initial plan
Copilot Jan 6, 2026
4389015
Initial plan for ACTIONS_ORCHESTRATION_ID user-agent support
Copilot Jan 6, 2026
d053ab3
Add ACTIONS_ORCHESTRATION_ID to user-agent string
Copilot Jan 6, 2026
baada7b
Apply prettier formatting to test file
Copilot Jan 6, 2026
f80dad6
Add underscore to valid orchestration ID characters
Copilot Jan 6, 2026
728b23b
Remove orchestration-id test file
Copilot Jan 6, 2026
8a9be95
Move helper method to end of file and revert package-lock.json changes
Copilot Jan 6, 2026
135f4fc
Replace invalid characters with underscore instead of removing them
Copilot Jan 6, 2026
b588811
Revert package-lock.json changes to remove peer flags
Copilot Jan 6, 2026
c36bdc0
Fix user-agent to handle empty string correctly
Copilot Jan 6, 2026
c0078b2
Simplify user-agent logic and update integration test
Copilot Jan 6, 2026
b67a972
Change orchestration ID format to actions_orchestration_id
Copilot Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add underscore to valid orchestration ID characters 
Co-authored-by: TingluoHuang <1750815+TingluoHuang@users.noreply.github.com>
  • Loading branch information
@TingluoHuang
Copilot and TingluoHuang committed Jan 6, 2026
commit f80dad6b51802013cabd11375d6043da2278a627
14 changes: 7 additions & 7 deletions __test__/orchestration-id.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ describe('getUserAgentWithOrchestrationId', () => {
process.env['ACTIONS_ORCHESTRATION_ID'] = orchestrationId

// Simulate the logic from getUserAgentWithOrchestrationId
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '')
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')
const result = `${baseUserAgent} orchestration-id/${sanitized}`

expect(result).toBe(
Expand All @@ -34,24 +34,24 @@ describe('getUserAgentWithOrchestrationId', () => {
const orchestrationId = 'test@orchestration#123!abc$xyz'

// Simulate the logic from getUserAgentWithOrchestrationId
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '')
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')
const result = `${baseUserAgent} orchestration-id/${sanitized}`

expect(result).toBe(
'actions/github-script orchestration-id/testorchestration123abcxyz'
)
})

test('preserves dots and hyphens in orchestration ID', () => {
test('preserves dots, hyphens, and underscores in orchestration ID', () => {
const baseUserAgent = 'actions/github-script'
const orchestrationId = 'test.orchestration-123'
const orchestrationId = 'test.orchestration-123_abc'

// Simulate the logic from getUserAgentWithOrchestrationId
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '')
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')
const result = `${baseUserAgent} orchestration-id/${sanitized}`

expect(result).toBe(
'actions/github-script orchestration-id/test.orchestration-123'
'actions/github-script orchestration-id/test.orchestration-123_abc'
)
})

Expand All @@ -73,7 +73,7 @@ describe('getUserAgentWithOrchestrationId', () => {
const orchestrationId = '@#$%^&*()'

// Simulate the logic from getUserAgentWithOrchestrationId
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '')
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')
const result = sanitized
? `${baseUserAgent} orchestration-id/${sanitized}`
: baseUserAgent
Expand Down
4 changes: 2 additions & 2 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36268,8 +36268,8 @@ function getUserAgentWithOrchestrationId(userAgent) {
if (!orchestrationId) {
return userAgent;
}
// Sanitize orchestration ID - only keep alphanumeric, dots, and hyphens
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '');
// Sanitize orchestration ID - only keep alphanumeric, dots, hyphens, and underscores
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '');
if (!sanitized) {
return userAgent;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ function getUserAgentWithOrchestrationId(userAgent: string): string {
return userAgent
}

// Sanitize orchestration ID - only keep alphanumeric, dots, and hyphens
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9.-]/g, '')
// Sanitize orchestration ID - only keep alphanumeric, dots, hyphens, and underscores
const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')
if (!sanitized) {
return userAgent
}
Expand Down