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.

Sign up for GitHub

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

Jump to bottom

chore(adapters): cleanup extraneous documentation in adapter and fix testing and release GHA #10854

Merged
merged 17 commits into from
May 9, 2024
Merged

chore(adapters): cleanup extraneous documentation in adapter and fix testing and release GHA #10854

merged 17 commits into from
May 9, 2024

Conversation

ndom91
Copy link
Member

@ndom91 ndom91 commented May 8, 2024 •
edited
Loading

☕️ Reasoning

  • Removed ## Setup .. type docs in each adapter's JSDoc in their respective index.ts files. This also included stuff like schema migration's and migrations from v1 to v2 of the adpater, etc. Stuff that doesn't really belong in JSDoc imo
  • The remaining JSDoc docs are just the API reference 👌
  • I double checked, all of that documentation is already updated for v5 and available under authjs.dev/getting-started/adapters/* for each adapter
  • Fix example app build, bug in /api/[...proxy]/route.ts exports
  • Prettier

Actions

  • Cleanup release.yml GHA
    • Bump all job deps
    • Fix E2E step
    • Add 2hr timeout to release-* jobs
    • Prep E2E-docker job for re-enablement

🧢 Checklist

  • Documentation
  • Tests
  • Ready to be merged

🎫 Affected issues

📌 Resources

@ndom91 ndom91 requested a review from ubbe-xyz as a code owner May 8, 2024 17:14
@vercel Vercel
Copy link

vercel bot commented May 8, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
auth-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2024 9:52am
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
next-auth-docs ⬜️ Ignored (Inspect) Visit Preview May 9, 2024 9:52am
proxy ⬜️ Ignored (Inspect) Visit Preview May 9, 2024 9:52am

@github-actions github-actions bot added adapters Changes related to the core code concerning database adapters firebase @auth/firebase-adapter dynamodb @auth/dynamodb-adapter fauna @auth/fauna-adapter mikro-orm @auth/mikro-orm-adapter mongodb @auth/mongodb-adapter neo4j @auth/neo4j-adapter pouchdb @auth/pouchdb-adapter sequelize @auth/sequelize-adapter upstash-redis @auth/upstash-redis-adapter supabase @auth/supabase-adapter typeorm @auth/typeorm-adapter xata @auth/xata-adapter drizzle @auth/drizzle-adapter kysely d1 hasura surrealdb pg azure-tables edgedb unstorage labels May 8, 2024
@codecov Codecov
Copy link

codecov bot commented May 8, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.97%. Comparing base (fbc89ea) to head (f91a4fb).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #10854      +/-   ##
==========================================
- Coverage   39.08%   37.97%   -1.12%     
==========================================
  Files         168      173       +5     
  Lines       26871    27238     +367     
  Branches     1140     1174      +34     
==========================================
- Hits        10503    10343     -160     
- Misses      16368    16895     +527

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ndom91 ndom91 requested a review from ThangHuuVu as a code owner May 8, 2024 18:25
@ndom91 ndom91 changed the title chore(adapters): cleanup extraneous documentation in adapter index files chore(adapters): cleanup extraneous documentation in adapter and fix testing and release GHA May 9, 2024
@ndom91 ndom91 merged commit 8751fa4 into main May 9, 2024
14 of 15 checks passed
@ndom91 ndom91 deleted the ndom91/cleanup-adapter-jsdoc-docs branch May 9, 2024 09:58
@ndom91 ndom91 mentioned this pull request May 9, 2024
Merged
3 tasks
hillac pushed a commit to hillac/next-auth that referenced this pull request Jun 19, 2024
@ndom91 @hillac
chore(adapters): cleanup extraneous documentation in adapter and fix …
e5c80c3 
…testing and release GHA (nextauthjs#10854)
k3k8 pushed a commit to k3k8/next-auth that referenced this pull request Aug 1, 2024
@ndom91 @k3k8
chore(adapters): cleanup extraneous documentation in adapter and fix …
4b636e2 
…testing and release GHA (nextauthjs#10854)
JipSterk pushed a commit to JipSterk/next-auth that referenced this pull request Aug 27, 2024
@ndom91 @JipSterk
chore(adapters): cleanup extraneous documentation in adapter and fix …
93e2805 
…testing and release GHA (nextauthjs#10854)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ubbe-xyz ubbe-xyz Awaiting requested review from ubbe-xyz ubbe-xyz is a code owner

@ThangHuuVu ThangHuuVu Awaiting requested review from ThangHuuVu ThangHuuVu is a code owner

Assignees
No one assigned
Labels
adapters Changes related to the core code concerning database adapters azure-tables d1 drizzle @auth/drizzle-adapter dynamodb @auth/dynamodb-adapter edgedb examples fauna @auth/fauna-adapter firebase @auth/firebase-adapter hasura kysely mikro-orm @auth/mikro-orm-adapter mongodb @auth/mongodb-adapter neo4j @auth/neo4j-adapter pg pouchdb @auth/pouchdb-adapter sequelize @auth/sequelize-adapter supabase @auth/supabase-adapter surrealdb typeorm @auth/typeorm-adapter unstorage upstash-redis @auth/upstash-redis-adapter xata @auth/xata-adapter
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ndom91