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: bump snyk-python-plugin version #5026

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

MarcusArdelean
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.

What does this PR do?

Updating the snyk-python-plugin version. The new version fixes the Required packages missing: <package_name> error . This was happening due to some symbol -, _, . miss-matching in the package names.

Where should the reviewer start?

The changes are available here: snyk-python-plugin PR

How should this be manually tested?

Running snyk test --command='python3' on any python 3 project.

Any background context you want to provide?

On some Linux os systems like Ubuntu 22.04, the 'python' command is not available, unless alias-ed with python3.

What are the relevant tickets?

https://snyksec.atlassian.net/browse/SUP-2395

@MarcusArdelean MarcusArdelean self-assigned this Jan 29, 2024
@MarcusArdelean MarcusArdelean requested a review from a team as a code owner January 29, 2024 14:12
package.json Outdated
@@ -123,7 +123,7 @@
"snyk-nuget-plugin": "2.3.3",
"snyk-php-plugin": "1.9.2",
"snyk-policy": "^1.25.0",
"snyk-python-plugin": "^2.0.6",
"snyk-python-plugin": "^2.0.7",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (blocking): Can we please pin this to the explicit version?

You can do this with:
npm i snyk-python-plugin@2.0.7 --save-exact

-E, --save-exact: Saved dependencies will be configured with an exact version rather than using npm's default semver range operator.
https://docs.npmjs.com/cli/v10/commands/npm-install#save-exact

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Changes done in f830651

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MarcusArdelean

@MarcusArdelean MarcusArdelean enabled auto-merge (squash) January 30, 2024 07:24
@MarcusArdelean MarcusArdelean merged commit 59c99f6 into master Jan 30, 2024
16 checks passed
@MarcusArdelean MarcusArdelean deleted the fix/bump-snyk-python-plugin branch January 30, 2024 08:20
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