Skip to content

docs: prefer Docker Hub image in README - #46

Merged
leonid-shevtsov merged 2 commits into
mainfrom
docs/docker-hub-readme
Jul 29, 2026
Merged

docs: prefer Docker Hub image in README#46
leonid-shevtsov merged 2 commits into
mainfrom
docs/docker-hub-readme

Conversation

@leonid-shevtsov

@leonid-shevtsov leonid-shevtsov commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

What & why

Docker Hub (mailtrap/mailtrap-local) is the primary public image; docs and release copy still pointed at GHCR first.

  • README Docker install uses mailtrap/mailtrap-local:latest (GHCR secondary)
  • Goreleaser release footer Docker example uses Docker Hub
  • Channel / changelog / CI comments list Docker Hub ahead of GHCR

How to test

  • Confirm README, release footer, and channel comments show Docker Hub first
  • Confirm GHCR still mentioned as a mirror / secondary publish target

Summary by CodeRabbit

  • Documentation
    • Updated Docker installation examples to use the Docker Hub image.
    • Clarified that the image is also available through GitHub Container Registry.
    • Revised repository and release documentation to consistently list Docker Hub and GHCR.
    • Updated release notes with UI improvements, bug fixes, and distribution details for the 0.2.0 and 0.1.0 releases.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f448fa68-7cd6-40b6-a09b-8e9aa7d25440

📥 Commits

Reviewing files that changed from the base of the PR and between dc70b40 and 182d958.

📒 Files selected for processing (5)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml
  • .goreleaser.yaml
  • CHANGELOG.md
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Docker image references and release documentation now use Docker Hub as the primary documented image source while noting publication to GHCR.

Changes

Docker registry references

Layer / File(s) Summary
Release registry metadata
.goreleaser.yaml, .github/workflows/ci.yml, .github/workflows/release.yml
Release comments and the generated Docker command now list Docker Hub before GHCR and use the Docker Hub image reference.
Installation and distribution documentation
README.md, CHANGELOG.md
Docker installation and distribution text now documents Docker Hub alongside GHCR.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: sergeykorolev, piobeny

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the main doc change: preferring the Docker Hub image in README.
Description check ✅ Passed The description covers motivation, changes, and test steps; only the optional Images and GIFs section is missing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Co-authored-by: Cursor <cursoragent@cursor.com>
@leonid-shevtsov
leonid-shevtsov merged commit 70199ce into main Jul 29, 2026
5 checks passed
@leonid-shevtsov
leonid-shevtsov deleted the docs/docker-hub-readme branch July 29, 2026 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants