Skip to content

Commit 5c78719

Browse files
committed
Address review comments
1 parent 9c9a765 commit 5c78719

File tree

2 files changed

+59
-17
lines changed

2 files changed

+59
-17
lines changed

docs/resources/projects/libraries.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ To import a library project into another FlutterFlow project, you must go to the
139139
- By default, the latest published version of the library is imported, but you can choose to depend on an earlier version if needed.
140140
- 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.
141141
- You must have a paid plan to import a library.
142-
142+
- 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**](version-management.md) and [**here**](version-management.md#version-management-with-libraries).
143143
:::
144144

145145

@@ -235,6 +235,8 @@ You can easily upgrade to newer versions of the libraries as they become availab
235235

236236
![update-library](imgs/update-library.avif)
237237

238+
239+
238240
## Library Values
239241

240242
**Library values** are essentially variables created and used by a library author and intended to have their values set by the library user. These values allow library author to create configurable variables that are useful in different contexts, such as API keys, global settings, or other project-specific configurations. These values allow library users to input specific data required for the library to function properly in their project.

docs/resources/projects/version-management.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ FlutterFlow is constantly evolving to provide new features, address bugs, and ke
1414
To mitigate these issues, FlutterFlow offers you a **Version Management** system that allows you to pin your project to a particular stable release of FlutterFlow. Projects pinned to a stable release will **not** automatically receive the latest FlutterFlow updates, giving you more control and stability over your development environment.
1515

1616
:::info
17-
18-
The FlutterFlow Version Management feature is available only on [**paid plans**](https://www.flutterflow.io/pricing).
19-
17+
Currently, the ability to pin a FlutterFlow project to a stable version is only available to **Enterprise** users.
2018
:::
2119

2220
## Why Version Management Matters
@@ -25,18 +23,23 @@ The FlutterFlow Version Management feature is available only on [**paid plans**]
2523
- **Offers Control Over Update Timing:** FlutterFlow updates might occur at inopportune times (e.g., right before you plan to deploy). Version Management allows you to choose **if and when** to move your project to a newer release.
2624
- **Enhances Reliability:** By using the pinned version, you can be confident that the same version of FlutterFlow, Flutter, and packages that you’ve tested will remain consistent, preventing surprises during critical development or deployment stages.
2725

26+
:::warning
27+
That said, there are **downsides** to consider: pinning your project to a stable release means you won’t receive the newest FlutterFlow features or bug fixes as they’re released. **We only recommend doing this if you have complex app with dependencies or custom code that could break when upgraded.**
28+
:::
29+
2830
## Key Concepts
2931

3032
Below are the foundational ideas behind FlutterFlow’s Version Management system. Understanding these concepts will help you maintain project stability and control when upgrading.
3133

3234
### Stable Release
3335

34-
A **stable release** of FlutterFlow is a version that has passed rigorous testing and is frozen to specific:
36+
A **stable release** of FlutterFlow is a version that has passed careful testing and is frozen to a specific:
3537

36-
- Flutter version
37-
- Pubspec dependencies
3838
- FlutterFlow frontend
3939
- Project code generation
40+
- Flutter version
41+
- Set of Pubspec dependencies
42+
4043

4144
Stable releases are chosen on a regular cadence (e.g., quarterly or monthly). **Note** that each stable release will be supported for a set duration (6 months by default).
4245

@@ -45,20 +48,27 @@ Stable releases are chosen on a regular cadence (e.g., quarterly or monthly). **
4548
When you “pin” your project to a stable release, no updates from FlutterFlow will apply to your project during the pinned period. Each stable release will have associated web and desktop frontends, allowing you to continue working on your project without interruptions.
4649

4750
:::info
48-
- **For Desktop**: You will download and install the dedicated binary for the pinned stable release. This binary won’t auto-update to give you a consistent development environment.
51+
- **For Desktop**: You will [**download**](https://www.flutterflow.io/desktop) and install the dedicated binary for the pinned stable release. This binary won’t auto-update to give you a consistent development environment.
4952
- **For Web**: You will access a unique URL to open the FlutterFlow pinned to that specific release.
5053
- **No forced upgrades**: You won’t be prompted to switch to the latest FlutterFlow release until your pinned version’s support window (e.g., 6 months) has ended.
54+
- **Pinning only from main branch**: You can only pin a FlutterFlow version if your project is on the main branch; pinning from other branches isn’t allowed.
5155
:::
5256

53-
To pin a project, navigate to **Settings and Integrations > Project Setup > Pin Version** and select the stable release you want to lock into.
57+
### Viewing and Modifying Pinned Versions
5458

55-
### Project Upgrades
59+
You can check the project’s pinned FlutterFlow version from the Dashboard.
5660

57-
When your project is pinned, you can only upgrade to a later stable release (downgrading to a previous stable release is not allowed) once you decide to move on from the current pinned version. You can unpin your project at any time, which will automatically update it to the latest available FlutterFlow release.
61+
To change the pinned version, navigate to **Settings and Integrations > General > App Details >** scroll down to the **Version Pinning** section and select the stable release you want to lock into. Once you update the pinned version, you can only edit the project using that version of FlutterFlow.
5862

59-
## FlutterFlow Version Workflow
63+
You can upgrade to a newer release or switch to an older one. However, if you choose to downgrade, any changes made after moving to a higher version will be lost.
64+
65+
:::info
66+
**Note that** only project owners can modify the pinned version.
67+
:::
68+
69+
70+
## Recommended FlutterFlow Version Workflow
6071

61-
Let’s understand the versioning workflow of setting up and managing a pinned project with an example. Understanding each phase ensures you can confidently control your project’s FlutterFlow version.
6272

6373
![versioning-workflow.avif](imgs/versioning-workflow.avif)
6474

@@ -68,6 +78,16 @@ Let’s understand the versioning workflow of setting up and managing a pinned p
6878
4. **Upgrade Directly to the Next Stable Release**: When FlutterFlow designates a future stable release, you can jump straight from 4 to 4.5 or 5, bypassing any issues in the in-between versions. This way, you only upgrade once, reducing the risk of multiple compatibility checks along the way.
6979
5. **Stay in Control**: While pinned to a stable release, FlutterFlow will **not** automatically update your project. You alone decide when (and if) to move to a later stable release or whatever latest version by unpinning the project.
7080

81+
## Version Management with Libraries
82+
83+
[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.
84+
85+
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.
86+
87+
:::info
88+
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; otherwise, you will encounter an error.
89+
:::
90+
7191
## FAQs
7292

7393
<details>
@@ -81,17 +101,37 @@ Any changes made in a higher version will be lost when you revert to a lower ver
81101
</details>
82102

83103
<details>
84-
<summary>Can I downgrade my project after upgrading to a new stable release?</summary>
104+
<summary>
105+
Can I edit my project in multiple versions of FlutterFlow?
106+
</summary>
107+
<p>
108+
No. If your project is not pinned to a specific version, you’ll always use the latest FlutterFlow release. If your project is pinned to a specific version of FlutterFlow, you will be prompted to edit the project in that version.
109+
</p>
110+
</details>
111+
112+
<details>
113+
<summary>
114+
How often are new stable versions released?
115+
</summary>
85116
<p>
86-
You will not be able to downgrade a project to a prior stable release. You can only choose to ‘pin’ your project to the next stable release that occurs (or has occurred) after your project change.
117+
We aim to release new stable versions of FlutterFlow once a month.
87118
</p>
88119
</details>
89120

90121
<details>
91122
<summary>
92-
Can I open the same project in multiple versions of FlutterFlow simultaneously?
123+
How can I see what's included in a new stable version?
93124
</summary>
94125
<p>
95-
No, you cannot open the same project in two different versions of FlutterFlow at the same time.
126+
We’re currently working on displaying release notes directly in the product, so you can easily review what’s been added or changed in each new stable version.
96127
</p>
97128
</details>
129+
130+
<details>
131+
<summary>
132+
What if there are bugs in the FlutterFlow version I’m using?
133+
</summary>
134+
<p>
135+
If critical bugs arise, we may provide hotfixes or patches for older FlutterFlow versions. However, some fixes depend on updating the underlying Flutter framework or related dependencies, which isn’t always feasible for older versions. This is a risk of staying on an older version of FlutterFlow as opposed to always using the latest.
136+
</p>
137+
</details>

0 commit comments

Comments
 (0)