Add save-state and set-output file commands by rentziass · Pull Request #1178 · actions/toolkit

rentziass · 2022-09-13T16:58:18Z

This adds support for the file command version of save-state and set-output that are being added to the runner in #2118.

In the case that these commands are being used on a runner that doesn't support the file-command versions they will fallback to the pre-existing workflow commands.

thboop · 2022-09-13T19:22:59Z

 }
+
+export function prepareKeyValueMessage(key: string, value: any): string {
+  const delimiter = `ghadelimiter_${uuidv4()}`


👍 on the refactor

thboop

lgtm

In version 1.10.0 of `@actions/core` they have fixed the warning we are getting for set-output in our github actions. As per per this PR actions/toolkit#1178 And as discussed here actions/toolkit#1218

skeggse · 2023-04-19T00:26:20Z

+  if (key.includes(delimiter)) {
+    throw new Error(
+      `Unexpected input: name should not contain the delimiter "${delimiter}"`
+    )
+  }


The check for the delimiter in the key feels a little misleading to me - if the key is user-controlled, it can still be used to add additional outputs if that's the risk being mitigated here; the delimiter doesn't capture the key, it just captures the value.

Suggested change

if (key.includes(delimiter)) {

throw new Error(

`Unexpected input: name should not contain the delimiter "${delimiter}"`

)

}

The `@actions/core` package has been updated to squash this warning: > The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ Notes: > Action authors who are using the toolkit should update the @actions/core package to v1.10.0 or greater to get the updated saveState and setOutput functions. https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md > ### 1.10.0 > - `saveState` and `setOutput` now use environment files if available [#1178](actions/toolkit#1178)

When running the tool, I get warning: Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ But I'm using the latest 1.11.0 version of actions/core npm module so this shouldn't happen? I found the PR that implemented a fix for the deprecation, actions/toolkit#1178, and in it, I see that it checks if it has access to the GITHUB_OUTPUT environment variable. If it doesn't, it will fallback to previous behavior. commit-id:c8c672a4

This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) ([source](https://github.com/actions/toolkit/tree/HEAD/packages/core)) | [`1.10.0` → `1.11.1`](https://renovatebot.com/diffs/npm/@actions%2fcore/1.10.0/1.11.1) | ![age](https://developer.mend.io/api/mc/badges/age/npm/@actions%2fcore/1.11.1?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@actions%2fcore/1.10.0/1.11.1?slim=true) | --- ### Release Notes <details> <summary>actions/toolkit (@actions/core)</summary> ### [`v1.11.1`](https://github.com/actions/toolkit/blob/HEAD/packages/core/RELEASES.md#1111) - Fix uses of `crypto.randomUUID` on Node 18 and earlier [#1842](actions/toolkit#1842) ##### 1.11.0 - Add platform info utilities [#1551](actions/toolkit#1551) - Remove dependency on `uuid` package [#1824](actions/toolkit#1824) ##### 1.10.1 - Fix error message reference in oidc utils [#1511](actions/toolkit#1511) ##### 1.10.0 - `saveState` and `setOutput` now use environment files if available [#1178](actions/toolkit#1178) - `getMultilineInput` now correctly trims whitespace by default [#1185](actions/toolkit#1185) ##### 1.9.1 - Randomize delimiter when calling `core.exportVariable` ##### 1.9.0 - Added `toPosixPath`, `toWin32Path` and `toPlatformPath` utilities [#1102](actions/toolkit#1102) ##### 1.8.2 - Update to v2.0.1 of `@actions/http-client` [#1087](actions/toolkit#1087) ##### 1.8.1 - Update to v2.0.0 of `@actions/http-client` ##### 1.8.0 - Deprecate `markdownSummary` extension export in favor of `summary` - [#1072](actions/toolkit#1072) - [#1073](actions/toolkit#1073) ##### 1.7.0 - [Added `markdownSummary` extension](actions/toolkit#1014) ##### 1.6.0 - [Added OIDC Client function `getIDToken`](actions/toolkit#919) - [Added `file` parameter to `AnnotationProperties`](actions/toolkit#896) ##### 1.5.0 - [Added support for notice annotations and more annotation fields](actions/toolkit#855) ##### 1.4.0 - [Added the `getMultilineInput` function](actions/toolkit#829) ##### 1.3.0 - [Added the trimWhitespace option to getInput](actions/toolkit#802) - [Added the getBooleanInput function](actions/toolkit#725) ##### 1.2.7 - [Prepend newline for set-output](actions/toolkit#772) ##### 1.2.6 - [Update `exportVariable` and `addPath` to use environment files](actions/toolkit#571) ##### 1.2.5 - [Correctly bundle License File with package](actions/toolkit#548) ##### 1.2.4 - [Be more lenient in accepting non-string command inputs](actions/toolkit#405) - [Add Echo commands](actions/toolkit#411) ##### 1.2.3 - [IsDebug logging](README.md#logging) ##### 1.2.2 - [Fix escaping for runner commands](actions/toolkit#302) ##### 1.2.1 - [Remove trailing comma from commands](actions/toolkit#263) - [Add "types" to package.json](actions/toolkit#221) ##### 1.2.0 - saveState and getState functions for wrapper tasks (on finally entry points that run post job) ##### 1.1.3 - setSecret added to register a secret with the runner to be masked from the logs - exportSecret which was not implemented and never worked was removed after clarification from product. ##### 1.1.1 - Add support for action input variables with multiple spaces [#127](actions/toolkit#127) - Switched ## commands to :: commands (should have no noticeable impact) \[[#110](https://github.com/actions/toolkit/issues/110))([#110](https://github.com/actions/toolkit/pull/110)) ##### 1.1.0 - Added helpers for `group` and `endgroup` [#98](actions/toolkit#98) ##### 1.0.0 - Initial release ### [`v1.11.0`](https://github.com/actions/toolkit/blob/HEAD/packages/core/RELEASES.md#1110) - Add platform info utilities [#1551](actions/toolkit#1551) - Remove dependency on `uuid` package [#1824](actions/toolkit#1824) ### [`v1.10.1`](https://github.com/actions/toolkit/blob/HEAD/packages/core/RELEASES.md#1101) - Fix error message reference in oidc utils [#1511](actions/toolkit#1511) </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 becomes conflicted, 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 [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.com/gitea/runner/pulls/880 Reviewed-by: Nicolas <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

rentziass requested a review from a team as a code owner September 13, 2022 16:58

thboop reviewed Sep 13, 2022

View reviewed changes

Comment thread packages/core/src/core.ts Outdated

thboop reviewed Sep 13, 2022

View reviewed changes

rentziass force-pushed the rentziass/file-commands branch from 9579083 to c08ee23 Compare September 16, 2022 17:57

rentziass added 2 commits September 28, 2022 13:53

Add save-state and set-output file commands

44f5f95

Address review comments

28f9431

rentziass force-pushed the rentziass/file-commands branch from c08ee23 to 28f9431 Compare September 28, 2022 13:53

rentziass requested review from a team as code owners September 28, 2022 14:16

rentziass force-pushed the rentziass/file-commands branch from a44786d to 28f9431 Compare September 28, 2022 14:18

rentziass removed request for a team September 28, 2022 14:19

default new env vars to empty

3a95e19

thboop approved these changes Sep 29, 2022

View reviewed changes

rentziass merged commit b00a9fd into main Sep 29, 2022

rentziass deleted the rentziass/file-commands branch September 29, 2022 13:45

rentziass mentioned this pull request Sep 29, 2022

@actions/core 1.10.0 release #1187

Merged

paescuj mentioned this pull request Sep 29, 2022

Unecessary newlines added to console output #777

Closed

This was referenced Oct 4, 2022

fix(test): set hard version of core to avoid issue with setoutput sfeir-open-source/sfeir-school-github-action-dev#42

Merged

Update toolkit/core to latest version sfeir-open-source/sfeir-school-github-action-dev#45

Closed

ishan1225 mentioned this pull request Dec 8, 2022

Update package @actions/core to remove deprecation warning chinthakagodawita/autoupdate#353

Closed

SamirMarin mentioned this pull request Dec 12, 2022

Samir marin patch 1 node16 and update actions/core to latest jgiannuzzi/setup-build-matrix#3

Closed

joshuanapoli mentioned this pull request Dec 15, 2022

Replace lodash.get with JMESPath query CumulusDS/get-yaml-paths-action#55

Merged

SamirMarin mentioned this pull request Dec 28, 2022

Update to node16 and actions/core to latest 1047Games/setup-build-matrix#1

Merged

gjtorikian mentioned this pull request Dec 28, 2022

I think this action or one of its dependencies are using an outdated GitHub Action syntax oxidize-rb/cross-gem-action#93

Closed

warnyul mentioned this pull request Jan 30, 2023

Update @actions/core to 1.10.0 jwenz723/github-app-installation-token#4

Merged

christophebedard mentioned this pull request Feb 12, 2023

Warning: The set-output command is deprecated and will be disabled soon. ros-tooling/action-ros-ci#780

Closed

rentziass mentioned this pull request Mar 8, 2023

Upgrade @actions/core to 1.10.0 for v2 actions/download-artifact#210

Merged

dangoslen mentioned this pull request Mar 14, 2023

Warning in Changelog Enforcer output dangoslen/changelog-enforcer#222

Closed

This was referenced Mar 16, 2023

Fixes for warnings and errors in the build. coqui-ai/STT#2345

Merged

Bug: Update set-output calls for ci pipeline v3 coqui-ai/STT#2351

Closed

alexrashed mentioned this pull request Mar 20, 2023

fix multiline outputs mad9000/actions-find-and-replace-string#11

Merged

skeggse reviewed Apr 19, 2023

View reviewed changes

AntoniosBarotsis mentioned this pull request May 21, 2023

Migrate off of deprecated GitHub Actions save-state command google/zerocopy#173

Closed

benjamincitrin mentioned this pull request Jun 2, 2023

The "set-output" command is deprecated and will be disabled soon. vemonet/setup-spark#21

Closed

elsewhat mentioned this pull request Aug 3, 2023

Warning on runs due to set-output command deprecated anthonyvscode/newman-action#450

Open

per1234 mentioned this pull request Sep 1, 2023

set-output deprecation MrOctopus/download-asset-action#6

Closed

davidgamero mentioned this pull request Sep 3, 2024

Feature Request: Migrate from set-output Azure/setup-kubectl#105

Closed

emilymclean mentioned this pull request Nov 13, 2024

Fix usage of deprecated set-output command recih/template-render-action#10

Merged

levibostian mentioned this pull request Nov 26, 2024

fix: github actions set-output is deprecated levibostian/decaf#40

Closed

github-actions Bot mentioned this pull request Aug 4, 2025

Parse git commits and provide to step scripts as input levibostian/decaf#77

Merged

2 tasks

github-actions Bot mentioned this pull request Nov 20, 2025

feat: run multiple commands for steps levibostian/decaf#99

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add save-state and set-output file commands#1178

Add save-state and set-output file commands#1178
rentziass merged 3 commits intomainfrom
rentziass/file-commands

rentziass commented Sep 13, 2022

Uh oh!

Uh oh!

thboop Sep 13, 2022

Uh oh!

thboop left a comment

Uh oh!

skeggse Apr 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

rentziass commented Sep 13, 2022

Uh oh!

Uh oh!

thboop Sep 13, 2022

Choose a reason for hiding this comment

Uh oh!

thboop left a comment

Choose a reason for hiding this comment

Uh oh!

skeggse Apr 19, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants