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: [OSM-1007] fixing a bug causing .NET beta scanning to fail on older versions of .NET #5228

Merged
merged 2 commits into from May 14, 2024

Conversation

dotkas
Copy link
Contributor

@dotkas dotkas commented May 8, 2024

The previous version of the plugin had a bug that would cause the scan to fail if running on older versions of the dotnet sdk.

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?

PR #5217 introduced a change that would behind-the-scenes call an MSBuild command only supported by newer versions of .NET.

Where should the reviewer start?

Only packages are changed. The actual bugfix is here: snyk/snyk-nuget-plugin#208 - the tests cover newer versions of .NET.

How should this be manually tested?

npm link the plugin and run it on one of the fixtures.

Any background context you want to provide?

The change was to give a more user-friendly error message to the user, but the scan would still fail.

So the logic is intact, so to speak. This change just re-introduces the original error when executed on older versions of .NET, instead of failing trying to create a user-friendly messaqge.

No new tests have been added, as we're already testing this against new versions of .NET. For older versions of .NET, the plugin will still fail .

What are the relevant tickets?

N/A

Screenshots

N/A

Additional questions

N/A

@dotkas dotkas requested a review from a team as a code owner May 8, 2024 06:33
@dotkas dotkas force-pushed the dotkas/OSM-1007/fix-broken-snyk-nuget-plugin-bug branch from 5f5ef98 to 876b6fc Compare May 8, 2024 19:44
@dotkas dotkas enabled auto-merge (squash) May 8, 2024 19:44
Copy link
Contributor

github-actions bot commented May 8, 2024

Warnings
⚠️

"fix: [OSM-1007] fixing a bug causing .NET beta scanning to fail on older versions of .NET" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against bc2751c

@dotkas dotkas force-pushed the dotkas/OSM-1007/fix-broken-snyk-nuget-plugin-bug branch 2 times, most recently from 31bdf4b to 4f2dcab Compare May 13, 2024 20:09
The previous version of the plugin had a bug that would cause the scan to fail if running on older versions of the `dotnet` sdk.
@dotkas dotkas force-pushed the dotkas/OSM-1007/fix-broken-snyk-nuget-plugin-bug branch from 4f2dcab to bc2751c Compare May 14, 2024 16:49
@dotkas dotkas merged commit 5fdecf7 into main May 14, 2024
15 checks passed
@dotkas dotkas deleted the dotkas/OSM-1007/fix-broken-snyk-nuget-plugin-bug branch May 14, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants