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

[OI-44] Allow docker.io as a registry base for container commands #5049

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

kat1906
Copy link
Contributor

@kat1906 kat1906 commented Feb 9, 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?

Update snyk-docker-plugin to allow docker.io/ as a prefix for images.

How should this be manually tested?

If you have docker running locally, the following works:

docker pull docker.io/confluentinc/cp-zookeeper:7.5.0
snyk container test docker.io/confluentinc/cp-zookeeper:7.5.0

If you don't have docker running locally, then the following does not work with the docker.io prefix:

snyk container test docker.io/confluentinc/cp-zookeeper:7.5.0

The upgrade to the snyk-docker-plugin library addresses this problem.

What are the relevant tickets?

OI-44

Risk assessment of the change

[LOW] Adds functionality which is backwards compatible

Tests that cover the updated functionality

  • PR shows the change with the test

@kat1906 kat1906 requested a review from a team as a code owner February 9, 2024 15:05
@PeterSchafer
Copy link
Contributor

Hey @kat1906
could you please take a look at the checklist in the PR Description to help us and others to better understand what this PR changes. I'm especially looking at the following points:

  • "contain a risk assessment of the change ..."
  • "contain a link to the automatic tests that cover the updated functionality." a link to tests in the external repo are also fine.
  • "ensure that the message of the final single commit is descriptive...", I know descriptive is not clearly specified, but what we are looking for is that users can understand what a new CLI version brings them feature or fix wise in a single sentence. A good start is to have it in the PR title. Ensuring that this title will be used when squashing the commits can be done after approval.

Thank you for your help!

@kat1906 kat1906 force-pushed the fix/upgrade_snyk-docker-plugin branch from 7e59f1a to f90c27d Compare February 12, 2024 11:24
@kat1906 kat1906 changed the title [OI-44] Update snyk-docker-plugin [OI-44] Allow docker.io as a registry base for container commands Feb 12, 2024
@kat1906 kat1906 force-pushed the fix/upgrade_snyk-docker-plugin branch from f90c27d to b55795c Compare February 12, 2024 11:25
@kat1906
Copy link
Contributor Author

kat1906 commented Feb 12, 2024

@PeterSchafer added the info, let me know if you require anything more

@PeterSchafer PeterSchafer merged commit 2b3c776 into master Feb 12, 2024
12 of 13 checks passed
@PeterSchafer PeterSchafer deleted the fix/upgrade_snyk-docker-plugin branch February 12, 2024 12:36
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