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 two bugs related to missing .deps files (.NET Beta) #5217

Merged
merged 1 commit into from
May 2, 2024

Conversation

dotkas
Copy link
Contributor

@dotkas dotkas commented May 1, 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?

Bumps the snyk-nuget-plugin to bring the CLI up to date after a few bugfixes has been done in that repo. (1, 2) as well as adding official command line docs to Gitbook at the same time: https://app.gitbook.com/o/-M4tdxG8qotLgGZnLpFR/s/-MdwVZ6HOZriajCf5nXH/~/changes/7042/snyk-cli/commands/test

Risk assessment: Low

The plugin updates always gets propagated to our SCM solution first where it is already heavily used, so any issues would automatically be picked up there first.

Where should the reviewer start?

I've added yet another acceptance test which should show the problem (see the README.md).

How should this be manually tested?

npm link to the newest version of snyk-nuget-plugin and run that against the fixture added in this repo.

Any background context you want to provide?

We're opening up .NET Beta from Closed Beta to Open Beta, hence the doc connection.

What are the relevant tickets?

See snyk-nuget-plugin PRs.

Screenshots

N/A

Additional questions

N/A

@dotkas dotkas changed the title fix: [OSM-1007] Updating .NET Beta helper text and fixing two bugs related to bad UX and unpublishable projects fix: [OSM-1007] Fixing two bugs related to bad UX of unpublishable projects (.NET Beta) May 1, 2024
@dotkas dotkas force-pushed the dotkas/OSM-1007/prep-for-dotnet-open-beta branch from 6c0e422 to b138259 Compare May 1, 2024 18:15
@dotkas dotkas changed the title fix: [OSM-1007] Fixing two bugs related to bad UX of unpublishable projects (.NET Beta) fix: [OSM-1007] Fixing two bugs related to missing .deps files (.NET Beta) May 1, 2024
Update with UX improvement on unscannable projects and fixed a bug where the .deps file could not be located in certain cases.
@dotkas dotkas force-pushed the dotkas/OSM-1007/prep-for-dotnet-open-beta branch from b138259 to b3611b5 Compare May 1, 2024 18:21
@dotkas dotkas marked this pull request as ready for review May 1, 2024 18:21
@dotkas dotkas requested a review from a team as a code owner May 1, 2024 18:21
@dotkas dotkas merged commit c27d767 into main May 2, 2024
16 checks passed
@dotkas dotkas deleted the dotkas/OSM-1007/prep-for-dotnet-open-beta branch May 2, 2024 08:51
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