6.0 KiB

Исходник Постоянная ссылка Ответственный История

New process/life-cycle flow
- Major differences with previous unstable/stable flow
- FAQ
  - Is there still a need for _unstable suffixes for hooks/utilities?
  - What's the process for updating already existing unstable package
    - package not released to npm yet (9.0.0-alpha.x):
    - package already released to npm as 9.0.0-(alpha|beta|rc).x:
Dev Guide

New process/life-cycle flow

Major differences with previous unstable/stable flow

unstable/preview components don't start with 9.0.0-<prerelease-type>.0
unstable/preview components will never be part of @fluentui/react-components suite. They can be used by installing independent package.
👉 react-components/unstable is frozen and deprecated - this api cannot be changed in any way
both stable and unstable(preview) should always use ^ within package.json dependencies (no more pinned versions for pre-releases needed)
*-preview packages are part of our official storybook public docs right after 1st release
- one can provide public doc-site link right away to designers/partners to test it out without any hacks
unstable/preview packages follow strict semantic versioning via 0.major.(minor|patch) pattern
- if your changes within preview package are breaking use change-type minor
- if you add new features or fixes within preview package use change-type patch

FAQ

Is there still a need for `_unstable` suffixes for hooks/utilities?

Any utilities that are in a stable package cannot be broken. Therefore, the purpose of the _unstable suffix has changed. If the owner feels confident that the API of that hook/utility has a sufficient level of extensibility, there is no need for a suffix. However, if there are doubts about the implementation that can be addressed in the future the _unstable suffix can communicate that to users. A stable version (i.e. one without the suffix) can be reserved for future use once there is more confidence the use case or functionality.

Any hooks/utilities with the _unstable suffix cannot be removed and cannot be broken until the next major version.

What's the process for updating already existing unstable package

package not released to npm yet (`9.0.0-alpha.x`):

All packages migration PR https://github.com/microsoft/fluentui/pull/28474

Let's say you have already created `packages/react-components/react-control` package which is in unstable phase.

Follow these steps:

rename package directory and api.md

mv packages/react-components/react-control packages/react-components/react-control-preview
mv packages/react-components/react-control/etc/react-control.api.md packages/react-components/react-control/etc/react-control-preview.api.md

Update README.md

-# @fluentui/react-control-preview
+# @fluentui/react-control

Update package.json

{
- "name": "@fluentui/react-control",
+ "name": "@fluentui/react-control-preview",
- "version": "9.0.0-alpha.0",
+ "version": "0.0.0",
  "beachball": {
    "disallowedChangeTypes": [
      "major",
-     "minor",
-     "patch",
+     "prerelease"
    ]
},
}

Update project.json

{
- "name": "@fluentui/react-control",
+ "name": "@fluentui/react-control-preview",
}

Update jest.config.js

module.exports = {
-  displayName: 'react-control',
+  displayName: 'react-control-preview',
}

Update tsconfig.base.json and tsconfig.base.all.json

"paths": {
- "@fluentui/react-control": ["packages/react-components/react-control/src/index.ts"]
+ "@fluentui/react-control-preview": ["packages/react-components/react-control-preview/src/index.ts"]
}

Update /github/CODEOWNERS

-packages/react-components/react-control @microsoft/<team-name>
+packages/react-components/react-control-preview @microsoft/<team-name>

now when ready to release follow Unstable phase (first release)

package already released to npm as `9.0.0-(alpha|beta|rc).x`:

automation PR in progress https://github.com/microsoft/fluentui/pull/28481

Dev Guide

Following chapters describe required steps for each phase. All of them are generated so it's only a matter of invoking proper generator.

Following graph sums those steps as well https://github.com/microsoft/fluentui/blob/master/tools/workspace-plugin/src/generators/prepare-initial-release/README.md#v9-release-process-flow

1. Kick-off phase

automation status: implemented ✅ / https://github.com/microsoft/fluentui/pull/28474

Bootstrap new package, via yarn create-package

yarn create-package

# triggers standard prompt

? Package name (do NOT include @fluentui prefix):  react-hello

This will do the usual scaffolding and adds -preview suffix to the package name automatically

2. Preview phase

automation status: implemented ✅ / https://github.com/microsoft/fluentui/pull/28505

yarn nx g @fluentui/workspace-plugin:prepare-initial-release --project @fluentui/react-one-preview --phase=preview

3. Stable phase