Added FlutterFlow Version Management #245
Conversation
|
|
|
@pinkeshmars left a bunch of comments - I think we need to clarify a bunch of things here, some things I still need to figure out myself so will get back to you on those |
|
One other thing to include is that you cant change the version off of main |
|
Actually we will only be launching this for enterprise this release, so will go out next week. Let's include a banner that says right now this is only available for enterprise users |
Added. |
ok, for now, I have replaced it with the existing 'paid plan' banner. |
|
Hi @leighajarett you can take a look again. Please note that, I could not include the visuals right now due to some issues. I'll post it in the eng ticket. |
|
Thanks @pinkeshmars - I made several changes and I think it looks good from my perspective. Since this is pretty complex, I will ask @agreaves and @br0nk to take a look as well |
leighajarett
requested review from
br0nk
and removed request for
PoojaB26 and
codywhunt
| - **Upgrade to more recent Stable Version**: When a new stable version is released, you will see it as an option in the dropdown shown above. You can upgrade the pinned version to a more recent stable version whenever they become available. Newer stable versions will have higher numbers (i.e. 5.1 is newer than 5.0) | ||
| - **Downgrade to a previous Stable Version:** You can downgrade to a prior stable release (i.e. downgrade from 5.1 to 5.0), however **changes made since upgrading will be lost** (i.e. changes made after modifying pinned version from 5.0 to 5.1). Therefore, we recommend [commiting](https://docs.flutterflow.io/collaboration/branching/#create-commits) all changes on the main branch before upgrading - plus testing after upgrading so you can quickly downgrade if necessary. | ||
| - **Set to *Latest Version* (Unpinned):** You can unpin your project by setting it to the *Latest Version* which will use the latest [standard release](#standard-release-corresponds-to-patch-version). | ||
| - **Opt-in to the *Next Stable*:** Your project may be on a standard version that does not have a correspond stable version (i.e. you are on 5.0.1 but the 5.0 stable will correspond to 5.0.4). In that case, you can choose to opt-in to the *Next Stable Version*. This will pin your project to the next stable version once it becomes available. |
There was a problem hiding this comment.
Nit: "corresponding"
There was a problem hiding this comment.
Updated! thanks @michael-mcroskey
docs/resources/projects/libraries.md
Outdated
| @@ -136,7 +136,7 @@ To import a library project into another FlutterFlow project, you must go to the | |||
| - By default, the latest published version of the library is imported, but you can choose to depend on an earlier version if needed. | |||
| - You can also import the `current` version of the library to use the latest state of the library on the main branch - however, this is not recommended. | |||
| - You must have a paid plan to import a library. | |||
|
|
|||
| - When you import a library into a project or another library, the library’s version must be lower than the project or library it’s being imported into. Learn more about managing the library’s FlutterFlow version [**here**](../projects/settings/version-management.md) and [**here**](../projects/settings/version-management.md#version-management-with-libraries). | |||
There was a problem hiding this comment.
lower than the project -> not set to 'current' and less than or equal to
| The version number consists of three parts: | ||
|
|
||
| - **Major Version:** Incremented when introducing substantial changes that significantly alter the product. | ||
| - **Minor Version:** Incremented for changes that notably enhance or modify the FlutterFlow development experience—such as upgrading to a new Flutter version or adding a large feature. |
There was a problem hiding this comment.
adding a large feature -> substantially changing generated code or project structure.
|
|
||
| - **Major Version:** Incremented when introducing substantial changes that significantly alter the product. | ||
| - **Minor Version:** Incremented for changes that notably enhance or modify the FlutterFlow development experience—such as upgrading to a new Flutter version or adding a large feature. | ||
| - **Patch Version:** Incremented with routine releases that include new features, improvements, or bug fixes. |
There was a problem hiding this comment.
Incremented for releases that contain bugfixes and minor improvements that do not contain breaking changes to generated code or project structure.
|  | ||
|
|
||
|
|
||
| #### Standard Release [Corresponds to Patch Version] |
|
|
||
| When your project is **not pinned** to a stable release (default behavior), you will automatically use the **latest standard release.** | ||
|
|
||
| #### Stable Release [Corresponds to Minor Version] |
| 2. When a new stable version is released, you can choose when you would like to upgrade based on your own release schedule and development process. For instance, you might wait until you're not actively developing a new feature, or you could check the release notes first to see if there are must-have features that would prompt you to upgrade sooner. | ||
| 3. When you’re ready to upgrade, commit all your changes on main to save your progress. Create a new branch from the main branch, [update the pinned version](#modifying-the-pinned-version), and test all functionalities to ensure compatibility. If any modifications are needed, make those changes in the new branch. | ||
| 4. Run your app on the platforms you support—using a simulator, emulator, or physical device to ensure everything works as intended. See the [Local Run documentation](https://docs.flutterflow.io/testing/local-run/) for details. | ||
| 4. If everything looks good, you can merge the new branch into the main branch. However, to merge branches successfully, ensure that both the main branch and the new branch are pinned to the same FlutterFlow version! If for some reason your app is not working as expected, you can choose to leave or close the branch until you are ready to make the modifications needed to support the latest FlutterFlow version (i.e. upgrade dependencies/custom code). |
There was a problem hiding this comment.
Done! Thanks :)
|
|
||
| ## Version Management with Libraries | ||
|
|
||
| [Libraries](../libraries.md) have their own versions, and each library version corresponds to a specific FlutterFlow version. The FlutterFlow version of the library version is determined by the version used (pinned or otherwise) when the project was updated. |
There was a problem hiding this comment.
Library versions don't really correspond 1:1 to Flutterflow versions. Library versions monotonically increase as libraries are released.
I would recommend instead saying:
Libraries have their own versions. Like projects, libraries edited in FlutterFlow can only be used in versions
of FlutterFlow >= the FlutterFlow version in which the library was was edited.
To ensure that new versions of libraries used in a pinned project are compatible with a pinned project, we
recommend pinning all libraries used in a pinned project to the same (or lower) Flutterflow version as the
pinned project.
Pinned projects cannot add a library with the version set to 'current' or to a library version that has been
edited on a later release of FlutterFlow.
Projects cannot be pinned if they a contain a library with the version set to 'current' or to a library version
that has been edited on a later release of FlutterFlow.
| Library projects can also be pinned to a specific version, ensuring that all library versions use that FlutterFlow release until the pinned version is changed. | ||
|
|
||
| :::info | ||
| When you import a library into a project or another library, the library’s version must be lower than the version used for the project it’s being imported into; otherwise, you will encounter an error. |
| <details> | ||
| <summary> | ||
| What happens if I downgrade to a lower version of FlutterFlow after making changes in a higher version? | ||
| </summary> | ||
| <p> | ||
| Any changes made in a higher version will be lost when you revert to a lower version (e.g., you made changes when you upgraded from 5.0 to 5.1, but then you want to downgrade back to 5.0). | ||
| **To avoid data loss, thoroughly test your app after upgrading to ensure you want to continue with the updated version.** | ||
| </p> | ||
| </details> |
There was a problem hiding this comment.
Omit this. Downgrading won't be supported in v0.
| What happens if there is no stable version available for me to pin my project to? | ||
| </summary> | ||
| <p> | ||
| If your project was created and edited on a [standard release](#standard-release-corresponds-to-patch-version) that does not correspond to a [stable version](#stable-release-corresponds-to-minor-version), you may not see an earlier stable version to downgrade to - because this would reset the state of your project. Instead, you can choose to opt-in to the [*next stable release*](#pinning-your-project). |
There was a problem hiding this comment.
not see an earlier stable version to downgrade to - because this would reset the state of your project. -> not see a stable version available.
Also add:
If set to the next stable release, a project will immediately be pinned when opened when a new stable release becomes available.
|
Left some comments based on what is actually included for v0. Mainly:
|
Thanks! I just commented on each. I think the usual process is to publish after the release? We are tentatively planning to release this on Thursday (tomorrow), but this is up to the discretion of Leigha & Sanjana |
ok, I have addressed the rest of the comments, so this PR is ready to merge now. Thanks @br0nk |
|
+@PoojaB26 for questions on when to publish this |
Description
Added FlutterFlow Version Management
Linear ticket and magic word Fixes DEVR-731
Type of change