supabase / supabase-flutter / 39775993593
93%

DEFAULT BRANCH: main
Ran
Jobs 11
Files 174
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 91.684% (-0.08%) from 91.762%
39775993593

push

github

web-flow 
docs: update every README to the v3 API (#2008)

Resolves
[SDK-2327](https://linear.app/supabase/issue/SDK-2327/docs-update-every-readme-to-the-v3-api).

The READMEs are the first code users and coding agents see, and several
still taught v2: untyped `from()` with `Map<String, dynamic>` rows,
`stream(primaryKey: ['id'])`, and `onPostgresChanges` with string table
names. This rewrites them for v3, for both human readers and coding
agents.

## What changed

- **Package skills.** The root, `supabase` and `supabase_flutter`
READMEs get a "Using an AI coding agent" section with `dart run skills@
get -p <package>` and a table of the skills each package ships.
`supabase_test` and `supabase_typegen` point at the matching testing and
schema skills.
- **Getting started as numbered steps** in `supabase_flutter` and
`supabase`: add the package, initialize, generate the typed schema
(`supabase_typegen` plus `supabase gen types --lang dart`, CLI 2.122.0
or newer), query.
- **A short "Rules of the v3 API" list** for the mistakes v2 habits
cause (`from()`, `anonKey`, `callback:`, a typed `update()` without
`where()`, catching `ClientException`, a stream created in `build()`).
- **Typed examples throughout**, using the `books`/`authors` schema the
skills use: `table()` reads and writes, `selectOnly` embeds, typed
`rpc`, typed `stream()` with a `StreamBuilder<List<BooksRow>>`, and
`onTableChanges` in place of `onPostgresChanges`. `from()` is only
mentioned as the untyped fallback.
- **New sections** in `supabase_flutter`: errors (the
`SupabaseException` hierarchy) and testing.
- **`supabase_test`**: every example moved to `table()`, and each one is
now a self-contained test.
- **`postgrest`**: a minimal typed example and a pointer to
`supabase_typegen`.
- **Broken snippets fixed** along the way: Apple sign in called an
unqualified `signInWithIdToken` without importing `crypto`, the Google
sign in used the removed `google_sign_in` 6 API, and the
`supabase_typegen`, `ice... (continued)

10717 of 11689 relevant lines covered (91.68%)

5.38 hits per line

Coverage Regressions

Lines Coverage ∆ File
14
44.44
-13.45% packages/postgrest/lib/src/postgrest_ordering.dart
9
90.48
-2.66% packages/postgrest/lib/src/postgrest_column_expression.dart
4
95.6
0.0% packages/supabase/lib/src/supabase_client.dart
4
94.35
-0.6% packages/supabase_flutter/lib/src/supabase.dart
2
93.1
2.19% packages/supabase/lib/src/supabase_typed_stream_builder.dart
Jobs
ID Job ID Ran Files Coverage
2 supabase_auth - 39775993593.2 34
93.38
GitHub Action Run
3 supabase_storage - 39775993593.3 10
96.26
GitHub Action Run
4 supabase_flutter - 39775993593.4 16
80.84
GitHub Action Run
5 yet_another_json_isolate - 39775993593.5 1
98.44
GitHub Action Run
6 supabase_typegen - 39775993593.6 6
94.36
GitHub Action Run
7 postgrest - 39775993593.7 28
91.42
GitHub Action Run
8 supabase - 39775993593.8 20
93.54
GitHub Action Run
9 supabase_functions - 39775993593.9 4
93.28
GitHub Action Run
10 iceberg - 39775993593.10 6
71.32
GitHub Action Run
11 supabase_realtime - 39775993593.11 14
91.17
GitHub Action Run
11 supabase_common - 39605471296.11 35
93.58
GitHub Action Run
Source Files on build 39775993593