Add updater job flag to update the dependency list without updating the dependency files #10836
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.
What are you trying to accomplish?
Resolve dependabot/cli#360 and further progress @jakecoffman's
dependabot ls
CLI suggestion from dependabot/cli#325.This change adds a new
update_dependency_list_only
attribute toDependabot::Job
.When true,
Dependabot::UpdateFilesCommand
will exit immediately after publishing to theupdate_dependency_list
API, skipping the call toDependabot::Updater.run()
. The option isfalse
by default.The change allows community users a way to use Dependabot purely for discovering dependencies, without actually updating them.
As mentioned in dependabot/cli#360, there is currently no obvious way (that I could find) for the community (outside GitHub) to use Dependabot [CLI] for security-only updates since a prerequisite of security-only updates is that the job definition contains the names of the vulnerable dependencies to be updated. The dependency names are not known until the update has started and discovery has completed, but the update cannot be started without first knowing the dependency names; catch-22.
Anything you want to highlight for special attention from reviewers?
I understand that contributions to the updater are generally not accepted and that within the GitHub hosted environment, this is a non-issue. I hope that you still consider this change (or some variation of it) to benefit community Dependabot implementations and users of Dependabot CLI.
If I have missed some obvious step that allows for security-only updates to be run without knowing the dependency names up-front, then this may not be required.
How will you know you've accomplished your goal?
Checklist