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: Improved 'npm dist-tags' handling for npm lockfile v2 and newer #5033

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

JCheung2004
Copy link
Member

@JCheung2004 JCheung2004 commented Feb 5, 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?

This PR was made to upgrade the nodejs-parser from 1.52.10 to 1.52.11 which improves "npm dist-tags" handling for npm lockfile v2 and newer

Where should the reviewer start?

Was tested within the plugin and within this PR

How should this be manually tested?

This can be tested on the CLI with the same fixture provided below. This would fail before the change.

Risk Assessment [MEDIUM]

Potential snapshot churn

Any background context you want to provide?

What are the relevant tickets?

JIRA Ticket

Zendesk Ticket

Screenshots

Additional questions

@JCheung2004 JCheung2004 force-pushed the fix/bump-node-js-parser-to-1.52.11 branch 6 times, most recently from bbe40d0 to d767b2f Compare February 9, 2024 15:20
@JCheung2004 JCheung2004 marked this pull request as ready for review February 9, 2024 15:22
@JCheung2004 JCheung2004 requested a review from a team as a code owner February 9, 2024 15:22
@JCheung2004 JCheung2004 force-pushed the fix/bump-node-js-parser-to-1.52.11 branch from d767b2f to 5a0b09d Compare February 9, 2024 16:19
@JCheung2004 JCheung2004 force-pushed the fix/bump-node-js-parser-to-1.52.11 branch from 5a0b09d to de437e5 Compare February 12, 2024 15:26
@PeterSchafer
Copy link
Contributor

PeterSchafer commented Feb 12, 2024

Issue: @JCheung2004 Please ensure that the PR title and the final message are more descriptive, see

ensure that the message of the final single commit is descriptive ...

The current message "bump nodejs-parser to 1.52.11", which will appear in the release notes doesn't give any indication what has changed in the Release. Please rephrase the PR title and thereby the squash commit message to explain the change in one sentence from a user perspective. The text will eventually end up here https://github.com/snyk/cli/releases

Copy link
Contributor

@j-luong j-luong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: apologies for the premature approval, could the above comment be resolved before merging?

@JCheung2004 JCheung2004 changed the title fix: bump nodejs-parser to 1.52.11 fix: Improved 'npm dist-tags' handling for npm lockfile v2 and newer Feb 12, 2024
@JCheung2004 JCheung2004 force-pushed the fix/bump-node-js-parser-to-1.52.11 branch from de437e5 to 6482213 Compare February 12, 2024 15:52
@JCheung2004 JCheung2004 merged commit 8d0d96a into master Feb 12, 2024
16 checks passed
@JCheung2004 JCheung2004 deleted the fix/bump-node-js-parser-to-1.52.11 branch February 12, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants