Skip to content

#CircleCI workflow and job execution #222

@Dargon789

Description

@Dargon789

Reviewer's Guide

Adds a new CircleCI 2.1 configuration file defining a custom Docker-based executor and a simple job wired into a basic workflow.

Flow diagram for CircleCI workflow and job execution

flowchart TD
  A["Code pushed to GitHub"] --> B["CircleCI detects change"]
  B --> C["Start Pipeline (version 2.1)"]
  C --> D["Run Workflow: my-custom-workflow"]
  D --> E["Queue Job: web3-defi-game-project-"]
  E --> F["Provision Executor: my-custom-executor"]
  F --> G["Pull Docker Image: cimg/base:stable (with DOCKER_HUB_USER / DOCKER_HUB_PASSWORD)"]
  G --> H["Job Step: checkout repository"]
  H --> I["Job Step: run shell script (currently placeholder)"]
  I --> J["Job completes"]
  J --> K["Workflow completes"]
Loading

File-Level Changes

Change Details Files
Introduce CircleCI pipeline configuration using a custom Docker executor and a minimal job/workflow setup.
  • Define CircleCI config version 2.1 and a reusable docker-based executor with authenticated access to Docker Hub via environment variables
  • Add a placeholder job that uses the custom executor, checks out the repository, and runs a stub shell step
  • Wire the job into a simple workflow to enable execution in the CircleCI pipeline
.circleci/ci-foundry.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 #220 (comment)

Metadata

Metadata

Assignees

Labels

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions