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 (ls): snyk code scanning in consistent ignores flow #5263

Merged
merged 1 commit into from
May 30, 2024

Conversation

teodora-sandu
Copy link
Contributor

@teodora-sandu teodora-sandu commented May 28, 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?

Updates snyk-ls so that it starts using the progress tracker from code-client-go for the consistent ignores flow.

How should this be manually tested?

For IntelliJ:

  • Run make build
  • Change the path to the CLI in IntelliJ in the Snyk Settings to the local CLI binary built in the previous step and disable automatically managing binaries
  • Make sure to use an org that has the snykCodeConsistentIgnores FF enabled (e.g. ide-consistent-ignores-test)
  • Have a look at the Snyk Code vulnerability

For the CLI:

  • Run make build
  • Make sure to use an org that has the snykCodeConsistentIgnores FF enabled (e.g. ide-consistent-ignores-test)
  • Run ./binary-releases/snyk-macos code test --org=ide-consistent-ignores-test --include-ignores in a repo

What are the relevant tickets?

https://snyksec.atlassian.net/browse/IDE-222

Screenshots

https://github.com/snyk/cli/assets/81559517/159eac3c-df7a-499d-9bd8-0a9840c7f691
Screenshot 2024-05-29 at 14 26 20

Screenshot 2024-05-29 at 14 26 20

@teodora-sandu teodora-sandu force-pushed the feat/progress-tracker branch 2 times, most recently from 104266c to 8a4588b Compare May 29, 2024 16:25
@teodora-sandu teodora-sandu marked this pull request as ready for review May 29, 2024 16:25
@teodora-sandu teodora-sandu requested a review from a team as a code owner May 29, 2024 16:25
@teodora-sandu teodora-sandu force-pushed the feat/progress-tracker branch 3 times, most recently from 3de111b to 653972f Compare May 29, 2024 16:29
@thisislawatts thisislawatts force-pushed the feat/progress-tracker branch from 653972f to 391d008 Compare May 29, 2024 21:37
@teodora-sandu teodora-sandu changed the title feat (ls): use progress tracker from code-client-go fix (ls): snyk code scanning in consistent ignores flow May 30, 2024
@teodora-sandu teodora-sandu force-pushed the feat/progress-tracker branch from 391d008 to 76b0af4 Compare May 30, 2024 09:10
@thisislawatts
Copy link
Member

@teodora-sandu you will need to adjust the commit message, I believe to remove the between fix and (ls)

@teodora-sandu teodora-sandu force-pushed the feat/progress-tracker branch from 76b0af4 to 7ab9b18 Compare May 30, 2024 12:42
@teodora-sandu teodora-sandu merged commit ebe0e2c into main May 30, 2024
15 checks passed
@teodora-sandu teodora-sandu deleted the feat/progress-tracker branch May 30, 2024 13:41
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