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(code): add support for '.snyk' excludes in go based 'snyk code' #5232

Merged
merged 2 commits into from
May 13, 2024

Conversation

j-luong
Copy link
Contributor

@j-luong j-luong commented May 10, 2024

Risk

Low - dependency update covered in existing tests

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?

This PR updates the go-application-framework dependency which updates two things in the go based snyk code command:

  • remove support for unused --only-ignores flag
  • support .snyk style excludes when filtering files for code scans

Where should the reviewer start?

Manual tests should validate the changes

How should this be manually tested?

  • build a local cli binary make clean build
  • add a .snyk file to repository that has a valid excludes section
  • run local cli binary <path/to/local/cli/binary> code test
    • validate that .snyk excludes are filtered
  • run local cli binary <path/to/local/cli/binary> code test --only-ignores
    • validate no change in behaviour

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

Copy link
Contributor

github-actions bot commented May 10, 2024

Warnings
⚠️

"feat(code): add support for ".snyk" style exdludes for go based "snyk code"" is too long. Keep the first line of your commit message under 72 characters.

⚠️

"chore(code): remove support for unused "--only-ignores" flag in go based "snyk code"" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against 646de99

@j-luong j-luong marked this pull request as ready for review May 10, 2024 10:43
@j-luong j-luong requested a review from a team as a code owner May 10, 2024 10:43
@j-luong j-luong marked this pull request as draft May 10, 2024 12:20
@j-luong j-luong force-pushed the feat/CLI-305_supportDotSnykExcludes branch from dfe5280 to 646de99 Compare May 13, 2024 09:11
@j-luong j-luong marked this pull request as ready for review May 13, 2024 09:11
@j-luong j-luong enabled auto-merge (squash) May 13, 2024 09:11
@j-luong j-luong merged commit ab2df50 into main May 13, 2024
15 checks passed
@j-luong j-luong deleted the feat/CLI-305_supportDotSnykExcludes branch May 13, 2024 09:48
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