Skip to content

Commit

Permalink
Update migration links
Browse files Browse the repository at this point in the history
  • Loading branch information
simondotm committed Apr 6, 2024
1 parent 7a1c025 commit 673c80b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
- Added a custom `migrate` generator to ensure workspace configurations match the latest plugin version schemas
- Updated plugin to be built against Nx 16.6.0

Read [here for plugin v2.0.0 -> v2.1.0+ migration instructions](docs/nx-firebase-migrations.md#migrating-from-plugin-v200-to-v210)

## v2.0.0 ![nx](https://img.shields.io/badge/Nx-v16.1.1-blue) ![nx](https://img.shields.io/badge/Node-v16-orange)

Official v2 release
Expand Down Expand Up @@ -63,7 +65,7 @@ Initial beta of plugin version 2.0.

This plugin was completely rewritten since V2.x to use esbuild for bundling cloud functions. For documentation of the legacy v1.x plugin version see [here](https://github.com/simondotm/nx-firebase/tree/release/v1.1.0).

Users of earlier plugin versions must read [here for plugin v1 -> v2 migration instructions](docs/nx-firebase-migrations.md)
Users of earlier plugin versions must read [here for plugin v1 -> v2 migration instructions](docs/nx-firebase-migrations.md#migration-from-plugin-v1x-to-v200)

> **Please note that legacy v1 versions of the plugin are no longer supported from this point on, so only take this update if you are prepared to migrate your workspace and Firebase projects**
Expand Down
4 changes: 2 additions & 2 deletions docs/nx-firebase-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Please note that these migrations are provided on a 'best effort' basis, due to
- [5. Library updates](#5-library-updates)
- [6. Check Migration](#6-check-migration)

## Migrating to plugin v2.1 from v2.0
## Migrating from plugin v2.0.0 to v2.1.0

Plugin version 2.1 [added some new features](../CHANGELOG.md#v210) that required changes to the project configurations.

Expand All @@ -27,7 +27,7 @@ This tool will run checks on your workspace firebase apps, functions and configu

> Please note, this generator is not the same as Nx's own migration tool, so always review the changes it makes to ensure they are appropriate for your workspace.
## Migration to plugin v2.x from v1.x
## Migration from plugin v1.x to v2.0.0

Version 2.x of this plugin has been completely rewritten, and uses a completely new approach to building & deploying, so migrating an existing Nx workspace using V1 of the plugin to use V2 requires some manual migration procedures.

Expand Down
5 changes: 3 additions & 2 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# User Guide


- [Migrating to new plugin versions](./nx-firebase-migrations.md)


**Nx Firebase Generators**

Expand All @@ -20,7 +20,8 @@

- [Nx-Firebase Sync](./nx-firebase-sync.md)
- [Nx-Firebase Project Schemas](./nx-firebase-project-structure.md)

- [Migrating to new plugin versions](./nx-firebase-migrations.md)

**Nx Workspace**

- [Nx Workspace Layout Ideas](./nx-workspace-layout.md)
Expand Down

0 comments on commit 673c80b

Please sign in to comment.