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: enhance sbt output width, fixing false positives vulns #5130

Merged
merged 1 commit into from Mar 29, 2024

Conversation

37IulianPopovici
Copy link
Contributor

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

  • There's no risk, added extra testing on plugin side that ensured everything works.

What does this PR do?

Bumps the snyk-sbt-plugin version to fix False Positives getting reported due to truncated output from sbt plugin
snyk/snyk-sbt-plugin#143

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Current change in snyk-sbt-plugin

Screenshots

Additional questions

@37IulianPopovici 37IulianPopovici self-assigned this Mar 22, 2024
@37IulianPopovici 37IulianPopovici requested a review from a team as a code owner March 22, 2024 10:26
@thisislawatts
Copy link
Member

@37IulianPopovici can you adjust the commit message so that it provides more context for consumers of the release notes?

Focus on the what rather than the how. Instead of "Upgraded external-dependency" explain the impact this has on users: "Improved search accuracy to deliver more relevant results". This way, users can easily see the value of upgrading to the latest release.
https://github.com/snyk/cli/blob/main/CONTRIBUTING.md#writing-commit-messages

@37IulianPopovici 37IulianPopovici changed the title fix: update sbt plugin version fix: enhance sbt output width, fixing false positives vulns Mar 25, 2024
@37IulianPopovici 37IulianPopovici force-pushed the fix/update-sbt-plugin-version branch 2 times, most recently from c425bbe to acf3219 Compare March 25, 2024 15:55
@37IulianPopovici
Copy link
Contributor Author

37IulianPopovici commented Mar 25, 2024

@37IulianPopovici can you adjust the commit message so that it provides more context for consumers of the release notes?

Focus on the what rather than the how. Instead of "Upgraded external-dependency" explain the impact this has on users: "Improved search accuracy to deliver more relevant results". This way, users can easily see the value of upgrading to the latest release.
https://github.com/snyk/cli/blob/main/CONTRIBUTING.md#writing-commit-messages

Forgot about that, thanks @thisislawatts!

@37IulianPopovici 37IulianPopovici force-pushed the fix/update-sbt-plugin-version branch 2 times, most recently from 590c526 to ee600aa Compare March 26, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants