Skip to content

#Docker image build and sign process in CI #89

@Dargon789

Description

@Dargon789

Reviewer's Guide

Introduces a new GitHub Actions workflow (.github/workflows/docker.yml) to automate building, tagging, pushing, and signing Docker images on scheduled runs, pushes to main, and pull requests.

Flow diagram for Docker image build and sign process in CI

flowchart TD
  Start(["Workflow Triggered (push, PR, schedule)"]) --> Checkout(["Checkout Repository"])
  Checkout --> Buildx(["Set up Docker Buildx"])
  Buildx --> Metadata(["Extract Docker Metadata"])
  Metadata --> BuildPush(["Build and Push Docker Image"])
  BuildPush -->|if not PR| Login(["Log into Docker Registry"])
  BuildPush -->|if not PR| Sign(["Sign Docker Image (Cosign)"])
  Sign --> Rekor(["Rekor Transparency Log"])
Loading

File-Level Changes

Change Details Files
Define workflow triggers and environment settings
  • Added schedule, push (branches and semver tags), and pull_request triggers
  • Declared REGISTRY and IMAGE_NAME environment variables
.github/workflows/docker.yml
Implement build job with Docker build, push, and signing
  • Configured job permissions (contents, packages, id-token) and runner
  • Checked out code and installed cosign except on PRs
  • Set up Docker Buildx for multi-platform builds and cache management
  • Logged into container registry when not in PR context
  • Used docker/metadata-action to generate tags and labels
  • Built and pushed the image with cache-from/to settings
  • Signed the pushed image digest using cosign and GitHub OIDC
.github/workflows/docker.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #88 (comment)

Sub-issues

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomersinvalidThis doesn't seem rightjavascriptPull requests that update javascript codequestionFurther information is requested

Projects

Status

In Review

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions