Thanks to visit codestin.com
Credit goes to github.com

Skip to content

# Flow diagram for the CI/CD Docker build-and-test job #65

@Dargon789

Description

@Dargon789

Reviewer's Guide

Adds a new GitHub Actions CI/CD workflow that builds a Docker image, runs end-to-end tests inside the container, and pushes the image to a Docker registry on main branch updates.

Flow diagram for the CI/CD Docker build-and-test job

flowchart TD
  trigger[Trigger: push to main or pull_request targeting main]
  job_start[Start job build-and-test on ubuntu-latest]
  checkout[Step: actions/checkout@v4]
  build[Step: docker build -t my-hardhat-app .]
  test[Step: docker run --rm my-hardhat-app npm run test:e2e]
  is_main{Is ref refs/heads/main?}
  login[Step: docker login using DOCKER_USERNAME and DOCKER_PASSWORD secrets]
  tag_push[Step: docker tag and docker push myrepo/my-hardhat-app:latest]
  end_success[Job success]

  trigger --> job_start --> checkout --> build --> test --> is_main
  is_main -->|no| end_success
  is_main -->|yes| login --> tag_push --> end_success
Loading

File-Level Changes

Change Details Files
Introduce a Docker-based CI/CD GitHub Actions workflow triggered on pushes and pull requests to main.
  • Create a workflow that runs on push and pull_request events targeting the main branch
  • Define a single ubuntu-latest job that checks out the repository and builds a Docker image tagged locally as my-hardhat-app
  • Run end-to-end tests inside the built Docker container using npm run test:e2e
  • On main branch pushes, log in to a Docker registry using stored secrets, retag the image as myrepo/my-hardhat-app:latest, and push it to the registry
.github/workflows/ci-cd-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 #64 (comment)

Metadata

Metadata

Assignees

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions