forked from foundry-rs/foundry
-
Notifications
You must be signed in to change notification settings - Fork 1
#### Sequence diagram for the new CircleCI 'say-hello' workflow #140
Copy link
Copy link
Open
Labels
P-highT-bugdependenciesPull requests that update a dependency filePull requests that update a dependency filedocumentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codegood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededinvalidThis doesn't seem rightThis doesn't seem rightquestionFurther information is requestedFurther information is requestedrustPull requests that update rust codePull requests that update rust code
Description
Reviewer's Guide
Introduces a CircleCI pipeline by adding a new configuration file that defines a simple Docker-based 'say-hello' job and a workflow to run it.
Sequence diagram for the new CircleCI 'say-hello' workflow
sequenceDiagram
actor Developer
participant CodeRepo as "Code Repository"
participant CircleCI
participant DockerRuntime as "Docker Runtime (cimg/base:current)"
Developer->>+CodeRepo: Push code
CodeRepo->>+CircleCI: Trigger pipeline (on commit)
CircleCI->>CircleCI: Parse .circleci/config.yml
CircleCI->>CircleCI: Start workflow "say-hello-workflow"
CircleCI->>+DockerRuntime: Execute job "say-hello"
DockerRuntime->>DockerRuntime: Step: checkout code
DockerRuntime->>DockerRuntime: Step: run "echo Hello, World!"
DockerRuntime-->>-CircleCI: Job status (success/failure)
CircleCI-->>-CodeRepo: Report build status
alt Optional: Notification
CodeRepo-->>-Developer: Notify build status
end
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce CircleCI configuration |
|
.circleci/config.yml |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto 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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Originally posted by @sourcery-ai[bot] in #47 (comment)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
P-highT-bugdependenciesPull requests that update a dependency filePull requests that update a dependency filedocumentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codegood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is neededinvalidThis doesn't seem rightThis doesn't seem rightquestionFurther information is requestedFurther information is requestedrustPull requests that update rust codePull requests that update rust code
Projects
Status
Backlog
Status
Todo