Releases: actions/github-script
Releases · actions/github-script
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 @Copilot in #695
- ci: use deployment: false for integration test environments by @salmanmkc in #712
- feat!: add getOctokit to script context, upgrade @actions/github v9, @octokit/core v7, and related packages by @salmanmkc in #700
New Contributors
- @Copilot made their first contribution in #695
Full Changelog: v8.0.0...v9.0.0
v8.0.0
What's Changed
- Update Node.js version support to 24.x by @salmanmkc in #637
- README for updating actions/github-script from v7 to v8 by @sneha-krip in #653
⚠️ Minimum Compatible Runner Version
v2.327.1
Release Notes
Make sure your runner is updated to this version or newer to use this release.
New Contributors
- @salmanmkc made their first contribution in #637
- @sneha-krip made their first contribution in #653
Full Changelog: v7.1.0...v8.0.0
v7.1.0
What's Changed
- Upgrade husky to v9 by @benelan in #482
- Add workflow file for publishing releases to immutable action package by @Jcambass in #485
- Upgrade IA Publish by @Jcambass in #486
- Fix workflow status badges by @joshmgross in #497
- Update usage of
actions/upload-artifactby @joshmgross in #512 - Clear up package name confusion by @joshmgross in #514
- Update dependencies with
npm audit fixby @joshmgross in #515 - Specify that the used script is JavaScript by @timotk in #478
- chore: Add Dependabot for NPM and Actions by @nschonni in #472
- Define
permissionsin workflows and update actions by @joshmgross in #531 - chore: Add Dependabot for .github/actions/install-dependencies by @nschonni in #532
- chore: Remove .vscode settings by @nschonni in #533
- ci: Use github/setup-licensed by @nschonni in #473
- make octokit instance available as octokit on top of github, to make it easier to seamlessly copy examples from GitHub rest api or octokit documentations by @iamstarkov in #508
- Remove
octokitREADME updates for v7 by @joshmgross in #557 - docs: add "exec" usage examples by @neilime in #546
- Bump ruby/setup-ruby from 1.213.0 to 1.222.0 by @dependabot[bot] in #563
- Bump ruby/setup-ruby from 1.222.0 to 1.229.0 by @dependabot[bot] in #575
- Clearly document passing inputs to the
scriptby @joshmgross in #603 - Update README.md by @nebuk89 in #610
New Contributors
- @benelan made their first contribution in #482
- @Jcambass made their first contribution in #485
- @timotk made their first contribution in #478
- @iamstarkov made their first contribution in #508
- @neilime made their first contribution in #546
- @nebuk89 made their first contribution in #610
Full Changelog: v7...v7.1.0
v7.0.1
What's Changed
- Avoid setting
baseUrlto undefined when input is not provided by @joshmgross in #439
Full Changelog: v7.0.0...v7.0.1
v7.0.0
What's Changed
- Add base-url option by @robandpdx in #429
- Expose async-function argument type by @viktorlott in #402, see for details https://github.com/actions/github-script#use-scripts-with-jsdoc-support
- Update dependencies and use Node 20 by @joshmgross in #425
New Contributors
- @navarroaxel made their first contribution in #285
- @robandpdx made their first contribution in #429
- @viktorlott made their first contribution in #402
Full Changelog: v6.4.1...v7.0.0
v2.1.0
What's Changed
- Bump @actions/core to 1.10.0 for v2 by @rentziass in #376
Full Changelog: v2...v2.1.0
v6.4.1
What's Changed
- Add @octokit/plugin-request-log, to produce debug output for requests by @mjpieters in #358
- fix input handling by @mjpieters in #357
- Remove unused dependencies by @mjpieters in #356
- Default debug to current runner debug state by @mjpieters in #363
New Contributors
- @mjpieters made their first contribution in #358
Full Changelog: v6.4.0...v6.4.1
v4.2.0
What's Changed
- Upgrade @actions/core to 1.10.0 for v4 by @rentziass in #349
Full Changelog: v4.1.1...v4.2.0
v5.2.0
What's Changed
- Upgrade @actions/core to 1.10.0 for v5 by @rentziass in #350
Full Changelog: v5.1.1...v5.2.0
v3.2.0
What's Changed
- Upgrade @actions/core to 1.10.0 for v3 by @rentziass in #348
Full Changelog: v3.1.1...v3.2.0