refactor: init now expects templates to have react-native version set #2422

blakef · 2024-06-20T18:11:16Z

Summary:

This will take advantage of changes coming in the way we publish the template: react-native-community/template/pull/30

refactor: init now expects templates to have react-native version set

For 0.75's previous RCs, we didn't have the infrastructure in place to
tag @react-native-community/templates 0.75-stable branch correctly, as
well as publishing the corresponding version to npm.

For example:

If @react-native-community/[email protected] is the latest version
published, and I specified --version next: I'd expect 0.75.1 of the
template to be used with 0.75.1 of react-native.

The downside of this approach is, if you init an older version then
things might not work.  You'd have to specify the matching template
using --template @react-native-community/template@<some version>. Given
that init is intended for new projects this isn't a concern for most
users.

We could look at abusing the `scripts` field to expose the corresponding
version of react native in the npm registry:

  https://registry.npmjs.org/@react-native-community/template

Something like: "scripts": { "version": "0.75.1-rc.2" }

Test Plan:

TODO: Run each of the combinations of the update table in the code. Might be difficult to do with unpublished @react-native-community/template npm packages published.

Checklist

Documentation is up to date to reflect these changes.
Follows commit message convention described in CONTRIBUTING.md

cortinico · 2024-06-20T19:25:34Z

@blakef let's make the CI green? 👍

packages/cli/src/commands/init/init.ts

blakef · 2024-06-21T12:55:47Z

I've made the changes requested and tested against:

Test	Outcome	Notes
`node ./packages/cli/build/bin.js init TestInit --skip-install --version next`	❌ but expected	Uses the `0.75.0-rc.0` version of the template which has the node `modules` issue
`node ./packages/cli/build/bin.js init TestInit --skip-install --version 0.75.0-rc.0`	❌ but expected	Uses the `0.75.0-rc.0` version of the template which has the node `modules` issue
`node ./packages/cli/build/bin.js init TestInit --skip-install --version next --template @react-native-community/[email protected]`	✅	It won't build, but the project generates correctly - React Native is 1000.0.0
`node ./packages/cli/build/bin.js init TestInit --skip-install --template @react-native-community/[email protected]`	✅	It won't build, but the project generates correctly - React Native is 1000.0.0

The depends on react-native-community/template#30 having published artefacts.

) There was a discussion on Discord, where we looked at implementing what was originally proposed. This is that implementation. It'll need to land with a [cli](react-native-community/cli#2422) change to use the update template + tagging. - feat: add mutating react-native & @react-native/ packages Support for doing this on nightly and release workflows - feat: added node ./scripts/updateReactNativeVersion.js <version> Sets the version of react-native and the @react-native/ scoped packages. It will also normalize tags to concrete versions. E.g. latest -> 0.74.2 - refactor: move scripts into a ./scripts folder

cortinico · 2024-06-21T13:31:11Z

packages/cli/src/commands/init/init.ts

-  //          this applies to all version before 0.75. The 1st release candidate is the minimal
-  //          version that has no template.
+  // Does the react-native@version package *not* have a template embedded. We know that this applies to
+  // all version before 0.75. The 1st release candidate is the minimal version that has no template.
  const useLegacyTemplate = semver.lt(
    version,
    TEMPLATE_COMMUNITY_REACT_NATIVE_VERSION,


This is 0.75.0-rc.0 so I'm unsure how this will work out with lt.
Should we just instead compare the minor from semver and do <= 74?

cortinico · 2024-06-21T13:32:20Z

packages/cli/src/commands/init/init.ts

+    // Suppose react-native 0.75.0 was released, and 0.74.8 was the previous version. If I ran
+    // `init --version 0.74.8` it would be guaranteed to work with the latest version of the template
+    // matching the MAJOR.MINOR, e.g. 0.74.21.
+    return `${TEMPLATE_PACKAGE_COMMUNITY}@~${version}`;


Here you should recompose the version no?

As what's going to happen if version is 0.75.0-rc.0?
What will ~0.75.0-rc.0 resolve? It should be ~0.75.0 instead.

I'm adding a branch for nightly which is the only tag that doesn't play nicely with ~.

I've made the changes requested and tested against:

Test Outcome Notes

node ./packages/cli/build/bin.js init TestInit --skip-install --version nightly ✅

node ./packages/cli/build/bin.js init TestInit --skip-install --version next ❌ but expected Uses the 0.75.0-rc.0 version of the template which has the node modules issue

node ./packages/cli/build/bin.js init TestInit --skip-install --version 0.75.0-rc.0 ❌ but expected Uses the 0.75.0-rc.0 version of the template which has the node modules issue

node ./packages/cli/build/bin.js init TestInit --skip-install --version next --template @react-native-community/[email protected] ✅ It won't build, but the project generates correctly - React Native is 1000.0.0

node ./packages/cli/build/bin.js init TestInit --skip-install --template @react-native-community/[email protected] ✅ It won't build, but the project generates correctly - React Native is 1000.0.0

The depends on react-native-community/template#30 having published artefacts.

For 0.75's previous RCs, we didn't have the infrastructure in place to tag @react-native-community/templates 0.75-stable branch correctly, as well as publishing the corresponding version to npm. For example: If @react-native-community/[email protected] is the latest version published, and I specified --version next: I'd expect 0.75.1 of the template to be used with 0.75.0-rc.1 of react-native. The downside of this approach is, if you init an older version then things might not work. You'd have to specify the matching template using --template @react-native-community/template@<some version>. Given that init is intended for new projects this isn't a concern for most users. We could look at abusing the `scripts` field to expose the corresponding version of react native in the npm registry: https://registry.npmjs.org/@react-native-community/template Something like: "scripts": { "version": "0.75.1-rc.2" }

Useful to see the error message instead of swallowing it if the user enables `--verbose`.

blakef mentioned this pull request Jun 20, 2024

refactor: automation to tag and version the template when releasing react-native-community/template#30

Merged

blakef changed the title ~~fix: only show warning about --template & --version when necessary~~ refactor: init now expects templates to have react-native version set Jun 20, 2024

cipolleschi approved these changes Jun 21, 2024

View reviewed changes

blakef force-pushed the feat/target-minor-template branch from dc419de to d709c04 Compare June 21, 2024 10:15

cortinico reviewed Jun 21, 2024

View reviewed changes

packages/cli/src/commands/init/init.ts Outdated Show resolved Hide resolved

blakef force-pushed the feat/target-minor-template branch from d709c04 to d55f6f9 Compare June 21, 2024 10:36

cortinico reviewed Jun 21, 2024

View reviewed changes

packages/cli/src/commands/init/init.ts Outdated Show resolved Hide resolved

blakef force-pushed the feat/target-minor-template branch from d55f6f9 to 315dc0a Compare June 21, 2024 12:44

cortinico reviewed Jun 21, 2024

View reviewed changes

blakef added 2 commits June 21, 2024 15:46

feat: output raw error on pods failing to install in debug

9ac0e05

Useful to see the error message instead of swallowing it if the user enables `--verbose`.

blakef force-pushed the feat/target-minor-template branch from 315dc0a to 9ac0e05 Compare June 21, 2024 14:46

cortinico approved these changes Jun 21, 2024

View reviewed changes

blakef marked this pull request as ready for review June 21, 2024 14:59

blakef requested review from adamTrz and thymikee as code owners June 21, 2024 14:59

blakef merged commit 2f4d63b into main Jun 21, 2024
10 checks passed

blakef deleted the feat/target-minor-template branch June 21, 2024 14:59

blakef mentioned this pull request Aug 16, 2024

feat/use npm registry blakef/cli#2

Open

This was referenced Oct 8, 2024

fix/ios xcworkspace with extra files blakef/cli#3

Closed

fix/ios xcworkspace with extra files blakef/cli#4

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: init now expects templates to have react-native version set #2422

refactor: init now expects templates to have react-native version set #2422

blakef commented Jun 20, 2024 •

edited by cipolleschi

Loading

cortinico commented Jun 20, 2024

blakef commented Jun 21, 2024

cortinico Jun 21, 2024

cortinico Jun 21, 2024

blakef Jun 21, 2024

blakef Jun 21, 2024

refactor: init now expects templates to have react-native version set #2422

refactor: init now expects templates to have react-native version set #2422

Conversation

blakef commented Jun 20, 2024 • edited by cipolleschi Loading

Summary:

Test Plan:

Checklist

cortinico commented Jun 20, 2024

blakef commented Jun 21, 2024

cortinico Jun 21, 2024

Choose a reason for hiding this comment

cortinico Jun 21, 2024

Choose a reason for hiding this comment

blakef Jun 21, 2024

Choose a reason for hiding this comment

blakef Jun 21, 2024

Choose a reason for hiding this comment

blakef commented Jun 20, 2024 •

edited by cipolleschi

Loading