feat(resolutions): support resolutions ignoring until given date #291
Conversation
This file contains 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
danadajian
reviewed
May 1, 2024
src/rules/resolutions.ts
Outdated
| @@ -15,8 +15,14 @@ import * as core from '@actions/core'; | |||
| import { PackageJson } from 'type-fest'; | |||
|
|
|||
| export const validateResolutions = (packageJson: PackageJson) => { | |||
| const ignoredResolutions = core.getMultilineInput('ignore-resolutions'); | |||
| const ignoreUntilDate = new Date(core.getInput('ignore-resolutions-until')); | |||
There was a problem hiding this comment.
What happens when core.getInput('ignore-resolutions-until') returns undefined? I think we should explicitly handle the case when this input is not provided
There was a problem hiding this comment.
That's actually a good shout. Have updated the logic and added a relevant test here.
Not a huge fan of nested if statements, but feels fairly all right for this use case.
padamczewski
force-pushed
the
feat/add-resolution-ignoring-by-date
branch
from
2dd0c08 to
18f473f
Compare
danadajian
approved these changes
May 5, 2024
|
🎉 This PR is included in version 1.9.0 🎉 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.
📝 Description
Why?
Even though we have the capability to exclude some packages included in
resolutionsfield from validation it doesn't cater for a case where we know ahead of time that we would like to be notified about pinning dependency eventually at some point in the future. Example that comes to mind:What?
This PR brings in additional
resolutionsrelated config in form of single line stringignore-resolutions-until, which is accepting a date as an input.How?
resolutionswhen they are present and ignore date is in the future: code and passing-testresolutionsexist, but date is in the past passing-testignore-resolutionswhen they matchresolutionseven though the date is in past passing-test🔗 Related Issues