Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add mailpit image #3121

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

silentworks
Copy link
Contributor

@silentworks silentworks commented Feb 9, 2025

What kind of change does this PR introduce?

Replace inbucket with mailpit. For now I'm opening this to start a discussion about this change as I believe mailpit provides more verbose features and works quite well after testing it for a week now. I've kept this PR at a minimal in order to keep backward compatibility and not have a breaking change. I did at first changed all references to inbucket to be mailpit but realised this would cause a break in everyone's config.toml since they would still be referencing [inbucket]. What could be done instead is to create a new config for mailpit but this time it should be given a universal name rather than the service we are using name. So instead of [inbucket] or [mailpit] it should be more generic like [mail] this way if this is to change in the future it would all be internal changes and none breaking to it's external use.

The benefits I see in mailpit is that it has features like HTML check and an API for e2e testing too. The UI looked more refined and having the various views like HTML, HTML Source, Text, Headers, Raw amongst others was also good.

To test this you would have to set the registry to docker.io as Supabase doesn't have a mirror image of mailpit.

Note supalocal is just an alias in my terminal to the built executable of the cli.

SUPABASE_INTERNAL_IMAGE_REGISTRY=docker.io supalocal start

What is the current behavior?

Please link any relevant issues here.

What is the new behavior?

Feel free to include screenshots if it includes visual changes.

Additional context

Add any other context or screenshots.

@silentworks silentworks requested a review from a team as a code owner February 9, 2025 18:54
@coveralls
Copy link

Pull Request Test Coverage Report for Build 13228671472

Details

  • 3 of 5 (60.0%) changed or added relevant lines in 1 file are covered.
  • 5 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.03%) to 58.319%

Changes Missing Coverage Covered Lines Changed/Added Lines %
internal/start/start.go 3 5 60.0%
Files with Coverage Reduction New Missed Lines %
internal/gen/keys/keys.go 5 12.9%
Totals Coverage Status
Change from base Build 13210912145: -0.03%
Covered Lines: 7676
Relevant Lines: 13162

💛 - Coveralls

Copy link
Contributor

@sweatybridge sweatybridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! I will start adding the image registry mirrors for ECR and ghcr.

@sweatybridge
Copy link
Contributor

I've mirrored the image to ghcr to unblock CI tests. https://github.com/orgs/supabase/packages/container/package/mailpit

Once this PR is approved, mirror to ECR will also happen.

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