Add ACTIONS_ORCHESTRATION_ID to user-agent string by Copilot · Pull Request #695 · actions/github-script

Copilot · 2026-01-06T21:02:45Z

Implementation Plan

Changes Made

Updated orchestration ID format in src/main.ts:

Changed from orchestration-id/${sanitized} to actions_orchestration_id/${sanitized}
This aligns with the expected naming convention

Example user-agent string:

actions/github-script actions_orchestration_id/5b37aec4-4d4a-4be1-8756-c1adf0e55d26 octokit-core.js/5.0.1 Node.js/24

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

https://github.com/github/actions-runtime/issues/5389

Co-authored-by: TingluoHuang <[email protected]>

src/main.ts

Co-authored-by: TingluoHuang <[email protected]>

Copilot · 2026-01-06T21:28:39Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

iojs.org
- Triggering command: /usr/bin/curl curl -q --fail --compressed -L -s REDACTED -o - (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

__test__/orchestration-id.test.ts

TingluoHuang · 2026-01-06T22:20:47Z

src/main.ts

+ * @param userAgent The base user agent string
+ * @returns The user agent string with orchestration ID appended if ACTIONS_ORCHESTRATION_ID is set
+ */
+function getUserAgentWithOrchestrationId(userAgent: string): string {


@copilot move the helper method to the end of the file

Moved the helper method to the end of the file in commit 8a9be95

TingluoHuang · 2026-01-06T22:21:04Z

package-lock.json

      "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.23.0.tgz",
      "integrity": "sha512-97z/ju/Jy1rZmDxybphrBuI+jtJjFVoz7Mr9yUQVVVi+DNZE333uFQeMOqcCIy1x3WYBIbWftUSLmbNXNT7qFQ==",
      "dev": true,
+      "peer": true,


@copilot why we need this? please undo

Reverted package-lock.json changes in commit 8a9be95. The "peer": true flags were added by npm during the initial setup and are not needed.

Co-authored-by: TingluoHuang <[email protected]>

Copilot · 2026-01-06T22:24:28Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

iojs.org
- Triggering command: /usr/bin/curl curl -q --fail --compressed -L -s REDACTED -o - (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Co-authored-by: TingluoHuang <[email protected]>

Copilot · 2026-01-06T22:32:40Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

iojs.org
- Triggering command: /usr/bin/curl curl -q --fail --compressed -L -s REDACTED -o - (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

TingluoHuang · 2026-01-06T22:35:56Z

src/main.ts

+  // Sanitize orchestration ID - only keep alphanumeric, dots, hyphens, and underscores
+  const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')


@copilot replace invalid string with _

Updated to replace invalid characters with underscore instead of removing them in commit 135f4fc

Example: test@#$123 now becomes test___123 instead of test123

Copilot · 2026-01-06T22:47:46Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

iojs.org
- Triggering command: /usr/bin/curl curl -q --fail --compressed -L -s REDACTED -o - (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

TingluoHuang · 2026-01-06T22:49:25Z

@copilot check CI failure and see if we need to fix our code or update the test

Copilot

Pull request overview

This PR adds the ACTIONS_ORCHESTRATION_ID environment variable to the user-agent string when making GitHub API requests. The orchestration ID is sanitized to ensure it only contains valid characters (alphanumeric, dots, dashes, and underscores) before being appended to the user-agent string in the format orchestration-id/{sanitized_id}.

Key changes:

Added getUserAgentWithOrchestrationId helper function to read, sanitize, and append the orchestration ID to the user-agent string
Modified user-agent construction in main() to always use a base user-agent and append orchestration ID when available
Applied sanitization that replaces invalid characters with underscores

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/main.ts	Added getUserAgentWithOrchestrationId function and integrated it into the main function's user-agent construction logic
dist/index.js	Compiled JavaScript output reflecting the TypeScript changes in main.ts

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/main.ts

Co-authored-by: TingluoHuang <[email protected]>

Copilot · 2026-01-06T22:55:49Z

@copilot check CI failure and see if we need to fix our code or update the test

Fixed the CI failure in commit c36bdc0. The Integration test was failing because when user-agent was explicitly set to an empty string, the code was defaulting to "actions/github-script" instead of using an empty string. Updated the logic to correctly distinguish between:

Empty string input → use empty string (no prefix)
No input provided → default to "actions/github-script"

TingluoHuang · 2026-01-06T23:00:37Z

@copilot check CI failure and see if we need to fix our code or update the test

Fixed the CI failure in commit c36bdc0. The Integration test was failing because when user-agent was explicitly set to an empty string, the code was defaulting to "actions/github-script" instead of using an empty string. Updated the logic to correctly distinguish between:

Empty string input → use empty string (no prefix)

No input provided → default to "actions/github-script"

@copilot i think we should update the tests.

Co-authored-by: TingluoHuang <[email protected]>

Copilot · 2026-01-06T23:06:09Z

@copilot check CI failure and see if we need to fix our code or update the test

Fixed the CI failure in commit [c36bdc0](c36bdc0a3af49bb7e233...

Updated the integration test in commit c0078b2 to expect 'actions/github-script' prefix even when user-agent is set to an empty string. Also simplified the user-agent logic to always default empty input to 'actions/github-script' for consistency.

TingluoHuang · 2026-01-07T04:12:50Z

TingluoHuang · 2026-01-07T04:14:03Z

src/main.ts

+  // Sanitize orchestration ID - replace invalid characters with underscore
+  const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '_')
+
+  return `${userAgent} orchestration-id/${sanitized}`


@copilot should be actions_orchestration_id/${sanitized}

Updated the format to actions_orchestration_id/${sanitized} in commit b67a972.

Co-authored-by: TingluoHuang <[email protected]>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://github.com/actions/github-script) | action | major | `v8.0.0` → `v9.0.0` | --- ### Release Notes <details> <summary>actions/github-script (actions/github-script)</summary> ### [`v9.0.0`](https://github.com/actions/github-script/releases/tag/v9.0.0) [Compare Source](actions/github-script@v8.0.0...v9.0.0) **New features:** - **`getOctokit` factory function** — Available directly in the script context. Create additional authenticated Octokit clients with different tokens for multi-token workflows, GitHub App tokens, and cross-org access. See [Creating additional clients with `getOctokit`](https://github.com/actions/github-script#creating-additional-clients-with-getoctokit) for details and examples. - **Orchestration ID in user-agent** — The `ACTIONS_ORCHESTRATION_ID` environment variable is automatically appended to the user-agent string for request tracing. **Breaking changes:** - **`require('@actions/github')` no longer works in scripts.** The upgrade to `@actions/github` v9 (ESM-only) means `require('@actions/github')` will fail at runtime. If you previously used patterns like `const { getOctokit } = require('@actions/github')` to create secondary clients, use the new injected `getOctokit` function instead — it's available directly in the script context with no imports needed. - `getOctokit` is now an injected function parameter. Scripts that declare `const getOctokit = ...` or `let getOctokit = ...` will get a `SyntaxError` because JavaScript does not allow `const`/`let` redeclaration of function parameters. Use the injected `getOctokit` directly, or use `var getOctokit = ...` if you need to redeclare it. - If your script accesses other `@actions/github` internals beyond the standard `github`/`octokit` client, you may need to update those references for v9 compatibility. #### What's Changed - Add ACTIONS\_ORCHESTRATION\_ID to user-agent string by [@Copilot](https://github.com/Copilot) in [#695](actions/github-script#695) - ci: use deployment: false for integration test environments by [@salmanmkc](https://github.com/salmanmkc) in [#712](actions/github-script#712) - feat!: add getOctokit to script context, upgrade [@actions/github](https://github.com/actions/github) v9, [@octokit/core](https://github.com/octokit/core) v7, and related packages by [@salmanmkc](https://github.com/salmanmkc) in [#700](actions/github-script#700) #### New Contributors - [@Copilot](https://github.com/Copilot) made their first contribution in [#695](actions/github-script#695) **Full Changelog**: <actions/github-script@v8.0.0...v9.0.0> </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/umati/Sample-Server/pulls/1678 Co-authored-by: umati-bot <[email protected]> Co-committed-by: umati-bot <[email protected]>

Initial plan

6599b48

Copilot AI assigned Copilot and TingluoHuang Jan 6, 2026

Copilot started work on behalf of TingluoHuang January 6, 2026 21:03 View session

Copilot AI and others added 3 commits January 6, 2026 21:07

Initial plan for ACTIONS_ORCHESTRATION_ID user-agent support

4389015

Co-authored-by: TingluoHuang <[email protected]>

Add ACTIONS_ORCHESTRATION_ID to user-agent string

d053ab3

Co-authored-by: TingluoHuang <[email protected]>

Apply prettier formatting to test file

baada7b

Co-authored-by: TingluoHuang <[email protected]>

Copilot AI changed the title ~~[WIP] Read environment variable and append to user-agent~~ Add ACTIONS_ORCHESTRATION_ID to user-agent string Jan 6, 2026

Copilot AI requested a review from TingluoHuang January 6, 2026 21:17

Copilot finished work on behalf of TingluoHuang January 6, 2026 21:17

TingluoHuang reviewed Jan 6, 2026

View reviewed changes

src/main.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of TingluoHuang January 6, 2026 21:23 View session

Add underscore to valid orchestration ID characters

f80dad6

Co-authored-by: TingluoHuang <[email protected]>

Copilot AI requested a review from TingluoHuang January 6, 2026 21:28

Copilot finished work on behalf of TingluoHuang January 6, 2026 21:28

TingluoHuang reviewed Jan 6, 2026

View reviewed changes

__test__/orchestration-id.test.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of TingluoHuang January 6, 2026 22:20 View session

TingluoHuang reviewed Jan 6, 2026

View reviewed changes

Remove orchestration-id test file

728b23b

Co-authored-by: TingluoHuang <[email protected]>

Copilot finished work on behalf of TingluoHuang January 6, 2026 22:24

Copilot AI requested a review from TingluoHuang January 6, 2026 22:24

Copilot started work on behalf of TingluoHuang January 6, 2026 22:25 View session

Move helper method to end of file and revert package-lock.json changes

8a9be95

Co-authored-by: TingluoHuang <[email protected]>

Copilot finished work on behalf of TingluoHuang January 6, 2026 22:32

TingluoHuang reviewed Jan 6, 2026

View reviewed changes

Copilot started work on behalf of TingluoHuang January 6, 2026 22:36 View session

TingluoHuang requested a review from a team as a code owner January 6, 2026 22:47

Copilot AI review requested due to automatic review settings January 6, 2026 22:47

Copilot started reviewing on behalf of TingluoHuang January 6, 2026 22:47 View session

Copilot AI requested a review from TingluoHuang January 6, 2026 22:47

Copilot finished work on behalf of TingluoHuang January 6, 2026 22:47

Copilot AI reviewed Jan 6, 2026

View reviewed changes

src/main.ts Outdated Show resolved Hide resolved

src/main.ts Show resolved Hide resolved

Copilot started work on behalf of TingluoHuang January 6, 2026 22:49 View session

Fix user-agent to handle empty string correctly

c36bdc0

Co-authored-by: TingluoHuang <[email protected]>

Copilot finished work on behalf of TingluoHuang January 6, 2026 22:57

Copilot AI temporarily deployed to debug-integration-test January 6, 2026 22:59 Inactive

Copilot started work on behalf of TingluoHuang January 6, 2026 23:01 View session

Simplify user-agent logic and update integration test

c0078b2

Co-authored-by: TingluoHuang <[email protected]>

Copilot finished work on behalf of TingluoHuang January 6, 2026 23:08

Copilot AI temporarily deployed to debug-integration-test January 6, 2026 23:09 Inactive

TingluoHuang reviewed Jan 7, 2026

View reviewed changes

Copilot started work on behalf of TingluoHuang January 7, 2026 04:14 View session

Change orchestration ID format to actions_orchestration_id

b67a972

Co-authored-by: TingluoHuang <[email protected]>

Copilot AI requested a review from TingluoHuang January 7, 2026 04:18

Copilot finished work on behalf of TingluoHuang January 7, 2026 04:18

Copilot AI temporarily deployed to debug-integration-test January 7, 2026 05:02 Inactive

SrRyan approved these changes Jan 7, 2026

View reviewed changes

TingluoHuang merged commit 450193c into main Jan 7, 2026
14 checks passed

TingluoHuang deleted the copilot/add-orchestration-id-user-agent branch January 7, 2026 15:23

		// Sanitize orchestration ID - only keep alphanumeric, dots, hyphens, and underscores
		const sanitized = orchestrationId.replace(/[^a-zA-Z0-9._-]/g, '')

Conversation

Copilot AI commented Jan 6, 2026 • edited by TingluoHuang Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implementation Plan

Changes Made

Uh oh!

Uh oh!

Copilot AI commented Jan 6, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Uh oh!

TingluoHuang Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

TingluoHuang Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jan 6, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI commented Jan 6, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

TingluoHuang Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jan 6, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

TingluoHuang commented Jan 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jan 6, 2026

Uh oh!

TingluoHuang commented Jan 6, 2026

Uh oh!

Copilot AI commented Jan 6, 2026

Uh oh!

TingluoHuang commented Jan 7, 2026

Uh oh!

TingluoHuang Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Jan 6, 2026 •

edited by TingluoHuang

Loading