fix: use core.getBooleanInput() to retrieve boolean input values
#223
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Yang-33
commented
Mar 29, 2025
|
@parkerbxyz PTAL~ |
gr2m
reviewed
Apr 4, 2025
|
We checked if the more strict interpretation of We are just having a look at the tests |
core.getBooleanInput() to retrieve boolean input valuescore.getBooleanInput() to retrieve boolean input values
|
🎉 This PR is included in version 2.0.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR switches from evaluating values passed to
skip-token-revokeas true if they are truthy in JavaScript, to usinggetBooleanInput. This change ensures that only proper YAML boolean values are recognized, preventing unintended evaluations to true.getBooleanInputis here: definition ofcore#getBooealnInputis here: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/core/src/core.ts#L188-L208The documentation states,
"If truthy, the token will not be revoked when the current job is complete", so this change could be considered a breaking change. This means that if there are users who rely ontruthyand expect values like whitespace or"false"to be evaluated as true (though this is likely rare), it would be a breaking change.Boolean(" ")andBoolean("false")are both evaluated as true.Alternatively, it can simply be considered a fix. How to handle this is up to the maintainer.
Resolve #216