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(nuget-plugin): [OSM-1754] remove isPublishable flag because it causes problems for older .NET versions #5276

Closed
wants to merge 1 commit into from

Conversation

andrei-cacio
Copy link

@andrei-cacio andrei-cacio commented May 30, 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.

Risk Assessment - [Low]

What does this PR do?

previous version of plugin includes a feature (isPublishable flag) which is problematic for older versions of .NET
snyk-nuget-plugin#212

This PR updates the snyk-nuget-plugin. This update is a revert on a functionality that didn't go as planned. We added a flag called isPublishable to provide better logging but it doesn't play well with older .NET versions. So we decided to remove it for now

Where should the reviewer start?

Please start from this OSM-1754 and read the brief on this, and see that this PR removes the functionality introduced in the PR within the JIRA ticket.

How should this be manually tested?

  • clone a dotnet 6 fixture from here
  • build local version of CLI binary with updated plugin
  • move local version of CLI binary to sample repo
  • docker run -it -v <pwd of sample repo>:/app mcr.microsoft.com/dotnet/sdk:6.0 /bin/bash
  • cd /app
  • apt-get update
  • snyk test
  • no errors should output

Any background context you want to provide?

We previously added the isPublishable check to our .NET plugin in this PR this was to better display betters errors to our users when they tried to scan a project with the <IsPublishable>false</IsPublishable> flag within their projects.

This was discovered to only work for .NET projects that were version 8+, and versions lower than this don't understand the command of isPublishable, providing more errors than needed for singular projects aswell as multi .NET projects

What are the relevant tickets?

OSM-1754

@andrei-cacio andrei-cacio requested a review from a team as a code owner May 30, 2024 14:18
@andrei-cacio andrei-cacio marked this pull request as draft May 30, 2024 14:18
@andrei-cacio andrei-cacio force-pushed the fix/bump-snyk-nuget-plugin branch from 432a34e to 514b23c Compare June 5, 2024 11:01
@andrei-cacio andrei-cacio changed the title fix: OSM-1754 bump snyk-nuget-plugin to 2.5.2 fix: OSM-1754 bump snyk-nuget-plugin to 2.6.1 Jun 5, 2024
@andrei-cacio andrei-cacio marked this pull request as ready for review June 5, 2024 11:15
@andrei-cacio andrei-cacio force-pushed the fix/bump-snyk-nuget-plugin branch 3 times, most recently from 6993c7d to c51dd88 Compare June 11, 2024 08:12
@andrei-cacio andrei-cacio changed the title fix: OSM-1754 bump snyk-nuget-plugin to 2.6.1 fix: [OSM-1754] remove isPublishable flag (which was added for better log messages) because it causes problems for older .NET versions Jun 11, 2024
@andrei-cacio andrei-cacio force-pushed the fix/bump-snyk-nuget-plugin branch from c51dd88 to d4e900c Compare June 11, 2024 08:31
Copy link
Contributor

github-actions bot commented Jun 11, 2024

Warnings
⚠️

"fix: OSM-1754 remove isPublishable flag because it breaks older .NET versions" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against b349344

@andrei-cacio andrei-cacio force-pushed the fix/bump-snyk-nuget-plugin branch from d4e900c to 465e352 Compare June 11, 2024 08:46
@j-luong j-luong changed the title fix: [OSM-1754] remove isPublishable flag (which was added for better log messages) because it causes problems for older .NET versions fix(nuget-plugin): [OSM-1754] remove isPublishable flag because it causes problems for older .NET versions Jun 12, 2024
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.

issue: could you complete the following sections in the PR template?

  • What does this PR do?
  • Where should the reviewer start?
  • How should this be manually tested?

In particular how can we manually test this change?

We will need to validate the behaviour works as expected when integrated in the CLI for approve this PR

@JCheung2004 JCheung2004 force-pushed the fix/bump-snyk-nuget-plugin branch from 465e352 to ac264b9 Compare June 21, 2024 13:23
@andrei-cacio andrei-cacio requested a review from j-luong June 25, 2024 11:14
@j-luong
Copy link
Contributor

j-luong commented Jun 28, 2024

This change will be included as part of #5309

@j-luong j-luong closed this Jun 28, 2024
@gemaxim gemaxim self-assigned this Jul 25, 2024
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.

3 participants