Merged
Conversation
Member
Author
|
the will generate a breaking change |
ba35234 to
8a2e525
Compare
Ziinc
requested changes
Feb 3, 2026
Contributor
|
Needs minor version bump |
c117cbb to
6793c62
Compare
Ziinc
approved these changes
Feb 4, 2026
zoedsoupe
added a commit
that referenced
this pull request
Mar 26, 2026
Reverts #81, we need to launch a different release for it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
After deprecating the self-managed client pattern in #80, the README and module documentation still extensively
documented and promoted the Agent-based pattern. This could confuse new users who might implement the deprecated
(and unsafe) pattern instead of the recommended functional approach.
Solution
@moduledocsections inlib/supabase/client.exthat explained the Agent-based usagelib/supabase.exdocstrings to remove mentions of self-managed clientsRationale
Documentation should reflect the recommended patterns, not deprecated ones. Since the self-managed pattern is now
deprecated (#80) due to race condition vulnerabilities, keeping it prominently featured in docs would actively
harm users by encouraging unsafe implementations.
The simplified docs now show only the functional pattern—creating lightweight client structs on-demand—which is
both safer and more idiomatic for server-side Elixir applications. Users still on the old pattern will see the
deprecation warnings when they compile.
Note: This PR depends on #80 (deprecation) being merged first.
Release-As: 0.8.0