feat: add support to dependabot's compatibility score #287
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
Eomm
reviewed
Oct 6, 2022
| @@ -45,5 +45,6 @@ exports.getInputs = inputs => { | |||
| APPROVE_ONLY: /true/i.test(inputs['approve-only']), | |||
| TARGET: mapUpdateType(inputs['target']), | |||
| PR_NUMBER: inputs['pr-number'], | |||
| COMPATIBILITY_SCORE: inputs['compatibility-score'], | |||
There was a problem hiding this comment.
Suggested change
| COMPATIBILITY_SCORE: inputs['compatibility-score'], | |
| COMPATIBILITY_SCORE: Number(inputs['compatibility-score']), |
| @@ -64,6 +65,20 @@ module.exports = async function run({ | |||
| ) | |||
| } | |||
|
|
|||
| const targetScore = +COMPATIBILITY_SCORE | |||
There was a problem hiding this comment.
moved the coercion to the input utility
Suggested change
| const targetScore = +COMPATIBILITY_SCORE | |
| const targetScore = COMPATIBILITY_SCORE |
| @@ -42,6 +42,10 @@ An example of a non-semantic version is a commit hash when using git submodules. | |||
|
|
|||
| _Optional_ A pull request number, only required if triggered from a workflow_dispatch event. Typically this would be triggered by a script running in a seperate CI provider. See [Trigger action from workflow_dispatch event](#trigger-action-from-workflow_dispatch-event) | |||
|
|
|||
| ### `compatibility-score` | |||
|
|
|||
| _Optional_ A minimum [Compatibility score](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-compatibility-scores) needed for the PR to be merged. | |||
There was a problem hiding this comment.
Suggested change
| _Optional_ A minimum [Compatibility score](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-compatibility-scores) needed for the PR to be merged. | |
| _Optional_ A minimum [Compatibility score](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-compatibility-scores) needed for the PR to be merged. The check will be skipped if the dependabot's PR does not include the compatibility score. |
| }, | ||
| dependabotMetadata: createDependabotMetadata({ | ||
| updateType: updateTypes.minor, | ||
| compatibilityScore: 91, |
There was a problem hiding this comment.
Could it be a float?
Suggested change
| compatibilityScore: 91, | |
| compatibilityScore: '90.9', |
L2jLiga
reviewed
Oct 6, 2022
| @@ -466,3 +466,96 @@ tap.test('should forbid minor when target is patch', async () => { | |||
| sinon.assert.notCalled(stubs.approveStub) | |||
| sinon.assert.notCalled(stubs.mergeStub) | |||
| }) | |||
|
|
|||
| tap.test( | |||
| 'should not allow merge with compatibility score lower than target score', | |||
There was a problem hiding this comment.
Since in documentation stated "security updates may include compatibility scores", I would also add test for case when compat score is not provided
|
I think we're blocked here for the moment, as we didn't quite figure out how to make this work over time. Meaning, reassessing the PRs if and when the compatibility score changes (as it is expected to) over time. |
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 adds support for using dependabot's compatibility score (retrieved from dependabot's fetch-metadata action) to decide whether to merge a PR or not.
Closes #286
Checklist
npm run testandnpm run benchmarkand the Code of conduct