You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Stable builds of Turborepo follow semantic versioning (semver) and are thoroughly tested before being released.
76
+
77
+
Turborepo also offers specific APIs that may be released in an earlier phase of development. This is to allow early adopters to give valuable feedback and help the core team gain confidence in APIs ahead of their stable release. APIs that are available pre-stable will be marked as such in the documentation and within `turbo` itself whenever possible.
78
+
79
+
Not every API will be released in every phase. We use our best judgement to determine the phase for an API based on our confidence for the feature, weighing factors like the feature's complexity, possible use cases, and feedback from early users of the API.
80
+
81
+
The Turborepo core team would like to thank any users who do use features early and express our appreciation for any feedback you provide.
82
+
83
+
### Stable
84
+
85
+
When an API reaches stability, it is considered ready for use in production. APIs marked as stable will only change in a backward-compatible way in a major release.
86
+
87
+
- If a stable API is going to **have breaking changes** in an upcoming major release, warnings and documentation will be provided to help with migrations and next steps.
88
+
- If a stable API is going to be **removed** in an upcoming major release, it will be marked as [Deprecated](#deprecated) to provide early notice of future removal.
89
+
90
+
### Beta
91
+
92
+
Beta APIs require more confidence around reliability before a stable release. In the Beta phase, we are confident about the overall design of the feature and expect to be able to promote the feature to stable with relatively few changes. In rare cases, an API may require a breaking change and will not be covered by semver.
93
+
94
+
We encourage early adopters to use Beta APIs to help us gain certainty around the feature's design and stability. Depending on your risk tolerance, you can use the feature in production as you see fit.
95
+
96
+
**APIs currently in the Beta phase:**
97
+
98
+
- None
99
+
100
+
### Experimental
101
+
102
+
Experimental APIs lack essential capabilities required to be ready for stability. The design of the feature is considered to be under active development and can change at any time.
103
+
104
+
We encourage you to help us test experimental APIs in side projects, proof-of-concepts, and other environments where stability is non-essential. This gives you the opportunity to aid in the API's development by providing early feedback to the core team as the feature develops. We do not recommend using experimental APIs where reliability is essential.
105
+
106
+
**APIs currently in the Experimental phase:**
107
+
108
+
-[`turbo query`](/repo/docs/reference/query)
109
+
-[`turbo boundaries`](/repo/docs/reference/boundaries) and [Tags](/repo/docs/reference/boundaries#tags)
110
+
-[`turbo ls`](/repo/docs/reference/ls)
111
+
-[`--experimental-write-cache` for `turbo watch`](/repo/docs/reference/watch#caching)
112
+
-[`--output=json` for `turbo ls --affected` flag](/repo/docs/reference/ls)
113
+
114
+
### Deprecated
115
+
116
+
Deprecated APIs are in the process of being removed. Any feature we intend to remove will include documentation for existing users with next steps and information on when to expect the feature to be removed.
117
+
118
+
**APIs that are currently deprecated:**
119
+
120
+
-`TURBO_REMOTE_ONLY` and `--remote-only`: Use [`TURBO_CACHE`](/repo/docs/reference/system-environment-variables) or [--cache](/repo/docs/reference/run#--cache-options)
0 commit comments