Skip to content

#### Flow diagram for new deployment orchestration steps in CircleCI #1787

@Dargon789

Description

@Dargon789

Reviewer's Guide

Refactor CircleCI config to move the project job inline within the workflow, replace the placeholder build step with a clear no-op marker, and append deployment orchestration commands for plan and status updates.

Flow diagram for new deployment orchestration steps in CircleCI

flowchart TD
  Start(["Start job in workflow"])
  Checkout(["Checkout code"])
  NoOp(["No-op run step"])
  PlanDeploy(["Plan a deploy (circleci run release plan)"])
  Success(["Update deploy to SUCCESS (circleci run release update --status=SUCCESS)"])
  Fail(["Update planned deploy to FAILED (circleci run release update --status=FAILED)"])

  Start --> Checkout --> NoOp --> PlanDeploy
  PlanDeploy --> Success
  PlanDeploy --> Fail
Loading

File-Level Changes

Change Details Files
Clarify no-op job placeholder
  • Updated run step comment to indicate intentional no-op
  • Replaced placeholder echo with echo "No operation"
.circleci/config.yml
Inline job configuration in workflow
  • Replaced external job reference under workflows with inline job mapping
  • Inlined executor and steps directly within the workflow job definition
.circleci/config.yml
Add deployment orchestration steps
  • Added ‘Plan a deploy’ step invoking circleci release plan
  • Added ‘Update a deploy to SUCCESS’ step with when: on_success
  • Added ‘Update planned deploy to FAILED’ step with when: on_fail
.circleci/config.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 #1786 (comment)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions