Sourced from actions/github-script's releases.
v9.0.0
New features:
getOctokitfactory 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 withgetOctokitfor details and examples.- Orchestration ID in user-agent — The
ACTIONS_ORCHESTRATION_IDenvironment 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/githubv9 (ESM-only) meansrequire('@actions/github')will fail at runtime. If you previously used patterns likeconst { getOctokit } = require('@actions/github')to create secondary clients, use the new injectedgetOctokitfunction instead — it's available directly in the script context with no imports needed.getOctokitis now an injected function parameter. Scripts that declareconst getOctokit = ...orlet getOctokit = ...will get aSyntaxErrorbecause JavaScript does not allowconst/letredeclaration of function parameters. Use the injectedgetOctokitdirectly, or usevar getOctokit = ...if you need to redeclare it.- If your script accesses other
@actions/githubinternals beyond the standardgithub/octokitclient, you may need to update those references for v9 compatibility.What's Changed
- Add ACTIONS_ORCHESTRATION_ID to user-agent string by
@Copilotin actions/github-script#695- ci: use deployment: false for integration test environments by
@salmanmkcin actions/github-script#712- feat!: add getOctokit to script context, upgrade
@actions/githubv9,@octokit/corev7, and related packages by@salmanmkcin actions/github-script#700New Contributors
@Copilotmade their first contribution in actions/github-script#695Full Changelog: https://github.com/actions/github-script/compare/v8.0.0...v9.0.0
3a2844b
Merge pull request #700
from actions/salmanmkc/expose-getoctokit + prepare re...ca10bbd
fix: use @octokit/core/types import for v7
compatibility86e48e2
merge: incorporate main branch changesc108472
chore: rebuild dist for v9 upgrade and getOctokit factoryafff112
Merge pull request #712
from actions/salmanmkc/deployment-false + fix user-ag...ff8117e
ci: fix user-agent test to handle orchestration ID81c6b78
ci: use deployment: false to suppress deployment noise from integration
tests3953caf
docs: update README examples from @v8 to @v9, add getOctokit docs
and v9 brea...c17d55b
ci: add getOctokit integration test joba047196
test: add getOctokit integration tests via callAsyncFunction