Fix cache-hit output when cache missed #1404

fchimpan · 2024-05-22T03:03:04Z

Description

According to the README, if the cache was not found, the output should be 'false'. However, it actually returned an empty string. This seems to be due to the behavior of GitHub Actions to return an empty string if the output is not defined. Please see these conversations.

I would like to change the code to return 'false' when the cache is not found, per the README.

Motivation and Context

In PR #1263, a README correction is suggested. This is a great initiative, thank you. However, to avoid confusion, how about changing the implementation instead?

How Has This Been Tested?

The issue was caused by not defining an output for cache-hit when the cache was not found, and then returning. Therefore, I will set the output before returning.

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (add or update README or docs)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

fchimpan · 2024-05-27T05:40:15Z

Hi, @bethanyj28
I would like to request a reviewer for this pull request. If you are not the reviewer, could you please recommend a suitable reviewer?

Thank you very much!

fchimpan · 2024-06-18T05:56:48Z

@joshmgross
I would like to request a reviewer for this pull request. If you are not the reviewer, could you please recommend a suitable reviewer?

Thank you very much!

joshmgross · 2024-06-18T19:59:01Z

src/restoreImpl.ts

@@ -62,7 +62,7 @@ export async function restoreImpl(
                    ...restoreKeys
                ].join(", ")}`
            );
-
+            core.setOutput(Outputs.CacheHit, false.toString());


Should we set this output before the if (failOnCacheMiss) case above?

That would ensure it's set even if fail-on-cache-miss is true.

Hi, @joshmgross

Thanks for your response.

Indeed, since it applies even in the case of exceptions, it seems good to output before failOnCacheMiss. What do you think?
6f5b5ee

Thanks @fchimpan!

Looks like the dist/ is out of date - could you re-run npm run build?

https://github.com/actions/cache/actions/runs/9599939755/job/26475812160?pr=1404

Thanks @joshmgross !
8addae5
I have pushed the dist.

fchimpan · 2024-06-21T00:58:58Z

I tested the implementation of this PR by actually using it. As expected, it was confirmed that ‘false’ is returned when the cache is not found.

v4 test : https://github.com/fchimpan/cache-pr-1404-test/actions/runs/9606621627
This PR test : https://github.com/fchimpan/cache-pr-1404-test/actions/runs/9606621624
Please see cache-miss job's Check outputs step.

fchimpan · 2024-06-26T11:57:42Z

Hi @joshmgross ,
I’ve made the necessary changes. Could you please review the code?

Thank you!

* fix: cache-hit output * fix: Output chache hit timing * fix: Output chache hit timing --------- Co-authored-by: Josh Gross <joshmgross@github.com>

v4hn · 2024-10-07T19:11:01Z

Comment: The ternary logic which this patch removes was a useful (but -granted- undocumented and broken) API to detect whether restore-keys was used.
E.g.,

steps:
- name: Restore Cache
  id: restore
  uses: actions/cache/restore@v4
  with:
    path: ...
    key: abc-${{ github.sha }}-${{ github.run_id }}-${{ github.run_attempt }}
    restore-keys: |
      abc-${{ github.sha }}-${{ github.run_id }}
- name: Run if any cache was restored
  if: steps.restore.outputs.cache-hit != ''
  ...

The correct way to get the same check seems to be
if: steps.restore.outputs.cache-matched-key != ''.
Maybe it makes sense to add that use-case in the README?

Jason3S · 2024-10-08T06:36:13Z

I think it would have been better to change the documentation. This was a major breaking change.

Jason3S · 2024-10-08T07:03:52Z

Before landing this type of change, it would be useful to check how it is used:
https://github.com/search?q=.cache-hit+language%3AYaml+&type=code

Ari-Kishon · 2024-10-08T07:21:35Z

This was a major change and should have been released as such.

The change in return value cause several critical steps in our workflows to be skipped and caused them all to fail.

I understand that this behavior has technically a bug, but given how long it returned empty values this should have been considered valid behavior and taken into account.

This change could have potentially disrupted development for my whole team had I not caught it before going on vacation.

We rely heavily on actions from this organization because we perceive them be stable and professionally maintained.

stof · 2024-10-08T09:05:18Z

The readme says that chache-hit is a boolean value: https://github.com/actions/cache?tab=readme-ov-file#outputs

The string 'false' is not a boolean value (and it is a truthy value). Please revert this broken change

v4hn · 2024-10-08T12:08:35Z

The readme says that chache-hit is a boolean value: https://github.com/actions/cache?tab=readme-ov-file#outputs

The string 'false' is not a boolean value (and it is a truthy value). Please revert this broken change

In that sense the API was inconsistent with the docs already before.
When a restore-keys entry was found instead of the primary key, 'false' was already returned before and a falsy value was only returned in case neither key was found.

stof · 2024-10-08T12:12:22Z

Then the readme correction proposed in #1263 is still relevant, even though the description of this PR says that it is meant to fix the implementation instead of having to clarify the readme (the PR of course needs to be adapted to account for the change done here)

nati-levi · 2024-10-08T15:15:53Z

This broke our CI.
Should have been major release.
Its a breaking change.

AnimMouse · 2024-10-08T15:58:01Z

This basically broke all of my composite actions.
It's sad that it's 2024, and GitHub Actions still can't make their type system right!
true and false are booleans, not strings!

joshmgross · 2024-10-08T16:03:51Z

👋 I will work on reverting this change

fix: cache-hit output

688d5d4

fchimpan requested a review from a team as a code owner May 22, 2024 03:03

joshmgross reviewed Jun 18, 2024

View reviewed changes

fchimpan added 2 commits June 21, 2024 00:09

fix: Output chache hit timing

6f5b5ee

fix: Output chache hit timing

8addae5

navalboyblue approved these changes Jul 17, 2024

View reviewed changes

Merge branch 'main' into fix-cache-miss-output

222d593

joshmgross self-assigned this Jul 31, 2024

joshmgross approved these changes Jul 31, 2024

View reviewed changes

Merge branch 'main' into fix-cache-miss-output

589c269

joshmgross enabled auto-merge (squash) July 31, 2024 16:55

joshmgross merged commit 40c3b67 into actions:main Jul 31, 2024
14 checks passed

joshmgross mentioned this pull request Aug 14, 2024

Cache-Hit output is null #1448

Closed

joshmgross mentioned this pull request Oct 3, 2024

Prepare 4.1.0 release #1464

Merged

prolic mentioned this pull request Oct 7, 2024

Bump actions/cache from 4.0.2 to 4.1.0 futrnostr/futr#29

Merged

Jason3S mentioned this pull request Oct 8, 2024

Cache-Hit set to string, not boolean, as of v4.1.0 #1466

Closed

AnimMouse mentioned this pull request Oct 8, 2024

Update to actions/cache outputs cache-hit as string instead of boolean AnimMouse/setup-rclone#10

Closed

joshmgross mentioned this pull request Oct 8, 2024

Restore original behavior of cache-hit output #1467

Merged

renovate bot mentioned this pull request Oct 8, 2024

fix(deps): update all non-major dependencies daku10/blog.daku10.dev#107

Open

1 task

bossOfCode mentioned this pull request Oct 30, 2024

Bump actions/cache from 4.0.2 to 4.1.2 in /.github/workflows bossOfCode/scratchattach#13

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cache-hit output when cache missed #1404

Fix cache-hit output when cache missed #1404

fchimpan commented May 22, 2024 •

edited

Loading

fchimpan commented May 27, 2024 •

edited

Loading

fchimpan commented Jun 18, 2024

joshmgross Jun 18, 2024

fchimpan Jun 20, 2024

joshmgross Jun 20, 2024

fchimpan Jun 20, 2024

fchimpan commented Jun 21, 2024 •

edited

Loading

fchimpan commented Jun 26, 2024

v4hn commented Oct 7, 2024

Jason3S commented Oct 8, 2024

Jason3S commented Oct 8, 2024

Ari-Kishon commented Oct 8, 2024 •

edited

Loading

stof commented Oct 8, 2024

v4hn commented Oct 8, 2024

stof commented Oct 8, 2024

nati-levi commented Oct 8, 2024

AnimMouse commented Oct 8, 2024

joshmgross commented Oct 8, 2024

Fix cache-hit output when cache missed #1404

Fix cache-hit output when cache missed #1404

Conversation

fchimpan commented May 22, 2024 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

fchimpan commented May 27, 2024 • edited Loading

fchimpan commented Jun 18, 2024

joshmgross Jun 18, 2024

Choose a reason for hiding this comment

fchimpan Jun 20, 2024

Choose a reason for hiding this comment

joshmgross Jun 20, 2024

Choose a reason for hiding this comment

fchimpan Jun 20, 2024

Choose a reason for hiding this comment

fchimpan commented Jun 21, 2024 • edited Loading

fchimpan commented Jun 26, 2024

v4hn commented Oct 7, 2024

Jason3S commented Oct 8, 2024

Jason3S commented Oct 8, 2024

Ari-Kishon commented Oct 8, 2024 • edited Loading

stof commented Oct 8, 2024

v4hn commented Oct 8, 2024

stof commented Oct 8, 2024

nati-levi commented Oct 8, 2024

AnimMouse commented Oct 8, 2024

joshmgross commented Oct 8, 2024

fchimpan commented May 22, 2024 •

edited

Loading

fchimpan commented May 27, 2024 •

edited

Loading

fchimpan commented Jun 21, 2024 •

edited

Loading

Ari-Kishon commented Oct 8, 2024 •

edited

Loading