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

feat: [OSM-955] Support for custom output paths for dotnet v2 projects #5015

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

dotkas
Copy link
Contributor

@dotkas dotkas commented Jan 21, 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?

Enables support for snyk test of .NET projects that specify a custom <OutputPath> in their manifests.

Before this change, doing

snyk test --dotnet-runtime-resolution --file=path/to/custom/project.assets.json
dotnet publish failed with error: MSBUILD : error MSB1003: Specify a project or solution file. The current working directory does not contain a project or solution file.

Due to obj/project.assets.json being the only expected path.

This change bumps the plugin which has solved this issue, see this PR.

Where should the reviewer start?

Acceptance tests and the test fixture that shows the problem.

How should this be manually tested?

cd test/acceptance/workspaces/nuget-app-8-custom-output-path
dotnet restore
dist/cli/index.js test --dotnet-runtime-resolution --file=dist/company/obj/project.assets.json

Any background context you want to provide?

N/A

What are the relevant tickets?

https://snyksec.atlassian.net/browse/OSM-955

Screenshots

N/A

Additional questions

N/A

@dotkas dotkas requested a review from a team as a code owner January 21, 2024 15:06
@dotkas dotkas force-pushed the dotkas/OSM-955/custom-output-path-for-dotnet-v2 branch from 97441d7 to 0483bdf Compare January 21, 2024 18:28
@dotkas dotkas enabled auto-merge (squash) January 22, 2024 18:15
@dotkas dotkas force-pushed the dotkas/OSM-955/custom-output-path-for-dotnet-v2 branch from 0483bdf to 5ebe5c6 Compare January 23, 2024 18:24
@thisislawatts thisislawatts force-pushed the dotkas/OSM-955/custom-output-path-for-dotnet-v2 branch from 5ebe5c6 to 62015b3 Compare January 30, 2024 16:02
@dotkas dotkas force-pushed the dotkas/OSM-955/custom-output-path-for-dotnet-v2 branch from 62015b3 to a633283 Compare February 5, 2024 22:10
@dotkas dotkas merged commit 6fc1d10 into master Feb 6, 2024
16 checks passed
@dotkas dotkas deleted the dotkas/OSM-955/custom-output-path-for-dotnet-v2 branch February 6, 2024 05:56
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