Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: upgrade snyk-docker-plugin to fix nodejs-parser dependency type #5301

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

adrobuta
Copy link
Contributor

@adrobuta adrobuta commented Jun 10, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

upgrades the version of snyk-docker-plugin 6.12.0-> 6.12.3
there was no change in [email protected] apart of changing the depency type for snyk-resolve-deps from dev to production dependency in this commit, this bump is made to avoid possible errors of type:
Cannot find module 'snyk-resolve-deps' from 'node_modules/snyk-docker-plugin/dist/analyzer/applications/node.js'

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@adrobuta adrobuta requested a review from a team as a code owner June 10, 2024 09:54
@PeterSchafer
Copy link
Collaborator

Hi @adrobuta,
Could you please help us and the CLI users better understand what the change means and what it's impact and risk is.
CLI users are often less interested in the bump of a dependency than what the issue exactly is fixed, so that they can understand and decide if a newer version solves a problem they have experienced.
Thanks for your support!

@adrobuta
Copy link
Contributor Author

adrobuta commented Jun 10, 2024

hi @PeterSchafer, there was no change in [email protected] apart of changing the depency type for snyk-resolve-deps from dev to production dependency in this commit, this bump is made to avoid possible errors of type:
Cannot find module 'snyk-resolve-deps' from 'node_modules/snyk-docker-plugin/dist/analyzer/applications/node.js'

Thanks a lot!

@adrobuta adrobuta force-pushed the fix/upgrade-snyk-docker-plugin branch 2 times, most recently from f3ff359 to 3df5c9f Compare June 10, 2024 15:23
@PeterSchafer
Copy link
Collaborator

hi @PeterSchafer, there was no change in [email protected] apart of changing the depency type for snyk-resolve-deps from dev to production dependency in this commit, this bump is made to avoid possible errors of type: Cannot find module 'snyk-resolve-deps' from 'node_modules/snyk-docker-plugin/dist/analyzer/applications/node.js'

Thanks a lot!

Thank you @adrobuta for the additional context!
To make more sense for external users, we try to focus on describing the what (fix issue xyz) rather than the how (bump plugin version). Applying this here is it correct to say

fix (container): Fix issues of type 'Cannot find module ...'

@PeterSchafer
Copy link
Collaborator

Based on your description of the changes I want to make sure you are aware:

This change includes a version change for snyk-nodejs-lockfile-parser from 1.53.0 to 1.57.0.

@adrobuta adrobuta force-pushed the fix/upgrade-snyk-docker-plugin branch 3 times, most recently from 0b780f4 to 7dd98f1 Compare June 11, 2024 10:34
@adrobuta adrobuta force-pushed the fix/upgrade-snyk-docker-plugin branch from 7dd98f1 to 4a91ebe Compare June 11, 2024 10:40
@adrobuta
Copy link
Contributor Author

hi @PeterSchafer , I'm aware of the version change of snyk-nodejs-lockfile-parser from 1.53.0 to 1.57.0, I tested container with the new versions of the dependencies. And I have updated the commit's message to be more suggestive on the what this versions bump tries to solve. thank you!

@PeterSchafer PeterSchafer merged commit 88efd54 into main Jun 11, 2024
15 checks passed
@PeterSchafer PeterSchafer deleted the fix/upgrade-snyk-docker-plugin branch June 11, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants