Skip to content

Commit a390e7d

Browse files
author
RoFlection Bot
committed
#nojira - release luau fixes (#391)
* Update version to proper 17.0.1 release * update all version strings and instructions
1 parent 57b89fc commit a390e7d

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ A comprehensive, but not exhaustive, translation of upstream ReactJS 17.x into R
88
## TL;DR
99

1010
* In a new project, you can consume this library by adding this line to your rotriever.toml
11-
* `React = "github.com/roblox/roact-alignment@17.0.1-rc.19"`
11+
* `React = "github.com/roblox/roact-alignment@17.0.1"`
1212
* If you have legacy Roact code, use the roact-compat library instead
13-
* `RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19"`
13+
* `RoactCompat = "github.com/roblox/roact-alignment@17.0.1"`
1414
* Make sure you are using the latest [rotriever](https://github.com/Roblox/rotriever/releases) 0.5 (or later) release
1515
* you can download the release binary, or add it to your `foreman.toml`: ```rotrieve = { source = "roblox/rotriever", version = "=0.5.6" }```
1616
* For unit testing components and trees of components, you'll want to use the [`act()`](https://github.com/threepointone/react-act-examples/blob/master/sync.md) API exported from the react-roblox package.

docs/api-reference/react.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ end)
353353
<a href='https://beta.reactjs.org/reference/react/Suspense' target="_blank"><img alt='React' src='../../images/reactjs.svg'/></a> <img alt='Deviation' src='../../images/deviation.svg'/>
354354

355355
!!! warning
356-
**While `React.Suspense` is technically implemented, it should be considered unusable as of version `17.0.1-rc.19`.** This is due to a limitation in Luau around recursive `pcall` depth. Future updates to React will unravel the recursive traversal and enable these features.
356+
**While `React.Suspense` is technically implemented, it should be considered unusable as of version `17.0.1`.** This is due to a limitation in Luau around recursive `pcall` depth. Future updates to React will unravel the recursive traversal and enable these features.
357357
Future version of React eliminate this recursive structure and should enable full use of `Suspense` and error boundaries.
358358

359359
Renders a subtree of children that can yield. If the children suspend while rendering, the `fallback` field provided will be used until the children have resolved their render.

docs/migrating-from-1x/upgrading-to-roact-17.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Roact 17 is available as a collection of packages hosted in the https://github.c
1313
2. Add the following to your `rotriever.toml` manifest file:
1414
```toml
1515
[dependencies]
16-
React = "github.com/roblox/roact-alignment@17.0.1-rc.19"
17-
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19"
16+
React = "github.com/roblox/roact-alignment@17.0.1"
17+
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1"
1818
```
1919
3. Run `rotrieve install` to install all dependencies
2020
4. `React.lua` and `ReactRoblox.lua` will be added to the `Packages` folder generated by rotriever in your project. Make sure this folder is included in your project when testing with `roblox-cli` or Roblox Studio.
@@ -27,7 +27,7 @@ Make the following changes to your `rotriever.toml` manifest file:
2727
```diff
2828
[dependencies]
2929
- Roact = "github.com/roblox/roact@1.4"
30-
+ Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" }
30+
+ Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" }
3131
```
3232

3333
This creates a dependency on the `RoactCompat` package, which provides [a compatibility layer](../api-reference/roact-compat.md) for migrating from legacy APIs.
@@ -39,9 +39,9 @@ Since it's still named `Roact` in the above snippet, it will be aliased to `Roac
3939
However, the `RoactCompat` API only covers enough to provide backwards compatibility. To access new features like hooks or suspense, you will need to add dependencies on `React` and `ReactRoblox` as well:
4040
```toml
4141
[dependencies]
42-
Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" }
43-
React = "github.com/roblox/roact-alignment@17.0.1-rc.19"
44-
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19"
42+
Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" }
43+
React = "github.com/roblox/roact-alignment@17.0.1"
44+
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1"
4545
```
4646

4747
The `RoactCompat` package **can be safely mixed and matched** with the new `React` and `ReactRoblox` packages; it's nothing more than a thin wrapper around them that aligns with the legacy Roact API and semantics.
@@ -64,7 +64,7 @@ You might encounter this if you have existing dependencies on any of the followi
6464
To resolve this, you can patch over any dependencies on legacy Roact and align them with your newly-added version. Add this additional section to your `rotriever.toml` manifest file:
6565
```toml
6666
[config.patch."github.com/roblox/roact"]
67-
Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" }
67+
Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" }
6868
```
6969

7070
To learn more about patching dependencies, check out [the Rotriever documentation](https://roblox.github.io/rotriever/guide/specifying-dependencies/#patching-dependencies).
@@ -82,7 +82,7 @@ One reasonable way to accomplish this is to depend on _both_ projects, but to co
8282
Roact = "github.com/roblox/roact@1.4"
8383

8484
[dev_dependencies]
85-
RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19"
85+
RoactCompat = "github.com/roblox/roact-alignment@17.0.1"
8686
```
8787

8888
This declares a dependency on legacy Roact as well as a [dev dependency](https://roblox.github.io/rotriever/guide/specifying-dependencies/#development-dependencies) on Roact 17.

rotriever.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[workspace]
2-
version = "17.0.1-rc.19"
2+
version = "17.0.1"
33
members = ["modules/*"]
44
authors = [
55
"Paul Doyle <pdoyle@roblox.com>",

standalone/rotriever.toml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[package]
22
name = "Roact17"
3-
version = "17.0.1-rc.19"
3+
version = "17.0.1"
44
content_root = "src"
55

66
[dependencies]
7-
RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19"
8-
React = "github.com/roblox/roact-alignment@17.0.1-rc.19"
9-
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19"
10-
ReactIs = "github.com/roblox/roact-alignment@17.0.1-rc.19"
7+
RoactCompat = "github.com/roblox/roact-alignment@17.0.1"
8+
React = "github.com/roblox/roact-alignment@17.0.1"
9+
ReactRoblox = "github.com/roblox/roact-alignment@17.0.1"
10+
ReactIs = "github.com/roblox/roact-alignment@17.0.1"

0 commit comments

Comments
 (0)