workflow updates for pgroll branches

xataio · Jul 29, 2024 · 36ca5e4 · 36ca5e4
1 parent 238d115
commit 36ca5e4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/020-Connect/010-Postgres/001-direct-access.mdx b/020-Connect/010-Postgres/001-direct-access.mdx
@@ -285,6 +285,10 @@ Concurrent connections are limited by [plan](/docs/concepts/pricing#pricing-plan
 
 Branch migrations are not supported yet. In databases that support direct Postgres access, you can create new branches but they cannot be merged together. This capability will become available later on.
 
+### Workflow
+
+Compatibility with the [PR based workflow](/docs/getting-started/workflow) is experimental as the migration system is being reworked based on [pgroll](https://github.com/xataio/pgroll).
+
 ## Column metadata
 
 Xata uses SQL comments on columns to track some replication-related metadata about certain types of columns. These comments are only ever present on columns created using the Xata UI, and only on certain types of columns.

diff --git a/050-Manage/040-pr-based-workflow.mdx b/050-Manage/040-pr-based-workflow.mdx
@@ -11,13 +11,11 @@ status: beta
 ## Migrations with GitHub
 
 <Alert status="warning">
-  **This feature is in beta and is not yet compatible with databases that provide direct access to
-  [Postgres](/docs/postgres)**. We are currently rebuilding our migration strategy to incorporate
-  [pgroll](https://github.com/xataio/pgroll) alongside native Postgres support. Until then, migrations and branching as
-  documented below are limited in scope. The GitHub integration does not work within a monorepo with multiple Xata
-  databases. File attachments within records will not get copied to generated preview branches. There is no rebase
-  capability at present, which meants migrations should be linear and targeted towards the main branch. GitHub Pull
-  Requests that apply migrations cannot be reverted.
+  **This feature is in Beta with known limitations**. Migrations and branching as documented below are limited in scope.
+  The GitHub integration does not work within a monorepo with multiple Xata databases. File attachments within records
+  will not get copied to generated preview branches. No data will be copied to preview branches with Postgres-enabled
+  databases. There is no rebase capability at present, which meants migrations should be linear and targeted towards the
+  main branch. GitHub Pull Requests that apply migrations cannot be reverted.
 </Alert>
 
 This guide introduces the core Xata workflow and outlines the process of configuring a project for branching and migrations using GitHub in conjunction with Netlify or Vercel. After completing the configuration, pull requests created in GitHub will generate Xata database previews that link to preview deployments in either Vercel or Netlify. After merging the pull requests, Xata will perform database migrations in sync with your code, resulting in the deployment of changes to production.