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

chore: publish build image to snyklabs #5122

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Conversation

cmars
Copy link
Contributor

@cmars cmars commented Mar 18, 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?

Publish the cli-build and cli-build-arm64 images used by CI tests to the snyklabs org in Docker Hub.

Use these in CI tests.

Where should the reviewer start?

CircleCI and Github action changes.

How should this be manually tested?

Note the successful manual run of the build image action against this branch.

Any background context you want to provide?

Publishing to a Snyk-controlled org rather than an individual user account makes our pipeline more robust.

Low risk & impact, as it only affects how an image used to run tests is sourced.

What are the relevant tickets?

CLI-166

Screenshots

Additional questions

@cmars cmars force-pushed the chore/snyklabs-cli-build-image branch 4 times, most recently from 38d6984 to 6bb3b48 Compare March 18, 2024 21:54
@cmars cmars marked this pull request as ready for review March 18, 2024 21:54
@cmars cmars requested a review from a team as a code owner March 18, 2024 21:54
@cmars cmars force-pushed the chore/snyklabs-cli-build-image branch 2 times, most recently from fc28712 to dd4a341 Compare March 19, 2024 00:08
@cmars cmars force-pushed the chore/snyklabs-cli-build-image branch from dd4a341 to 7c36181 Compare March 19, 2024 14:40
@cmars cmars enabled auto-merge (squash) March 19, 2024 15:04
@cmars cmars merged commit 74c864e into main Mar 20, 2024
14 checks passed
@cmars cmars deleted the chore/snyklabs-cli-build-image branch March 20, 2024 11:43
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