Skip to content

# Sequence diagram for Docker image build and push workflow (non-PR run) #42

@Dargon789

Description

@Dargon789

Reviewer's Guide

Introduces a new GitHub Actions workflow that automates Docker image building, tagging, caching, pushing, and cosign signing via Buildx, metadata-action, and sigstore tools, with scheduled, push, and pull request triggers and conditional steps for PR vs non-PR runs.

Sequence diagram for Docker image build and push workflow (non-PR run)

sequenceDiagram
  participant GitHub as "GitHub Actions Runner"
  participant Repo as "Repository"
  participant Buildx as "Docker Buildx"
  participant Registry as "Docker Registry (ghcr.io)"
  participant Cosign as "Cosign"
  participant Rekor as "Rekor Log"
  GitHub->>Repo: Checkout repository
  GitHub->>Buildx: Set up Buildx
  GitHub->>Registry: Login to registry
  GitHub->>Buildx: Build Docker image
  Buildx->>Registry: Push Docker image
  GitHub->>Cosign: Sign Docker image
  Cosign->>Rekor: Write to transparency log (if public)
Loading

Sequence diagram for Docker image build workflow (PR run)

sequenceDiagram
  participant GitHub as "GitHub Actions Runner"
  participant Repo as "Repository"
  participant Buildx as "Docker Buildx"
  GitHub->>Repo: Checkout repository
  GitHub->>Buildx: Set up Buildx
  GitHub->>Buildx: Build Docker image
  Note over Buildx: No push, login, or signing steps on PR
Loading

File-Level Changes

Change Details Files
Add Docker CI workflow
  • Define cron schedule, push, tag, and pull_request triggers
  • Set REGISTRY and IMAGE_NAME environment variables
  • Configure build job with Dockerfile build and dynamic tagging
  • Add steps: checkout, conditional cosign install, Buildx setup, conditional registry login
  • Extract image metadata and perform build-push with cache support
  • Sign pushed images using cosign and GitHub OIDC token
.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 #41 (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 requestedwontfixThis will not be worked on

Projects

Status

Backlog

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions