forked from foundry-rs/foundry
-
Notifications
You must be signed in to change notification settings - Fork 1
Closed
Labels
good first issueGood for newcomersGood for newcomers
Description
Reviewer's Guide
Adds a new GitHub Actions workflow to build, tag, and publish Docker images to Docker Hub on pushes, tags, and PRs, using buildx, metadata-based tagging, and conditional pushing vs. loading for PRs.
Sequence diagram for Docker image build and publish workflow
sequenceDiagram
actor Dev
participant GitHub
participant Workflow_Docker as Workflow_Docker
participant Docker_Login_Action as Docker_login_action
participant Buildx_Action as Docker_setup_buildx_action
participant Metadata_Action as Docker_metadata_action
participant Build_Push_Action as Docker_build_push_action
participant Docker_Registry as docker_io
Dev->>GitHub: push to main or tag / open PR
GitHub->>Workflow_Docker: trigger Docker workflow
Workflow_Docker->>Docker_Login_Action: authenticate with REGISTRY_USER and REGISTRY_TOKEN
Docker_Login_Action-->>Workflow_Docker: login successful
Workflow_Docker->>Buildx_Action: setup buildx builder
Buildx_Action-->>Workflow_Docker: buildx ready
Workflow_Docker->>Metadata_Action: compute tags and labels
Metadata_Action-->>Workflow_Docker: tags, labels (including SHA revision)
Workflow_Docker->>Build_Push_Action: build image with tags and labels
alt event is push or tag
Build_Push_Action->>Docker_Registry: push image and metadata
Docker_Registry-->>Build_Push_Action: push complete
else event is pull_request
Build_Push_Action-->>Workflow_Docker: load image locally only (no push)
end
Workflow_Docker-->>GitHub: job status and logs returned
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce Docker build and publish GitHub Actions workflow triggered on pushes, tags, and pull requests. |
|
.github/workflows/Docker.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 #338 (comment)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomers
Projects
Status
Done
Status
Done