Skip to content

Commit 96e0e3c

Browse files
andrewconnellandrewconnell
authored
Spfx v1.12.1 release (SharePoint#6911)
* add spfx v1.12.1 preview docs * add spfx v1.12.1 preview docs * update docs for developer preview installs * update include link * update TOC & doc for release date
1 parent 2d5037e commit 96e0e3c

File tree

4 files changed

+149
-0
lines changed

4 files changed

+149
-0
lines changed

‎docs/spfx/developer-preview-beta-features.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: SharePoint Framework developer preview releases
3+
description: Details on how to use developer preview pre-release packages with SharePoint Framework.
4+
ms.date: 04/13/2021
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework developer preview releases
9+
10+
Starting with SharePoint Framework (SPFx) v1.12, developers can try preview releases of new SPFx generator packages as part of a developer preview.
11+
12+
> [!CAUTION]
13+
> Developer preview releases aren't officially supported or recommended, especially for production projects and environments. These public preview releases are provided for the community to test and report issues prior to the official release.
14+
15+
## How to determine if a developer preview version is available
16+
17+
To determine if there's a preview release available, use the following command:
18+
19+
```console
20+
npm info @microsoft/generator-sharepoint
21+
```
22+
23+
The NPM **info** command will display a section **dist-tags** near the end of its output with two properties:
24+
25+
- **latest**: the current production released version of the package
26+
- **next**: the most recent developer preview release of the package
27+
28+
For example, the following is a sample output of what you'd see if you ran the above command. Note that some things have been omitted for brevity:
29+
30+
```text
31+
@microsoft/[email protected] | SEE LICENSE IN "EULA" FOLDER | deps: 11 | versions: 34
32+
Yeoman generator for the SharePoint Framework
33+
http://aka.ms/spfx
34+
35+
keywords: yeoman-generator
36+
37+
dist
38+
.tarball: https://registry.npmjs.org/@microsoft/generator-sharepoint/-/generator-sharepoint-1.11.0.tgz
39+
.shasum: 43323fa642165e4ce5b1b9d4624244b07d6332bb
40+
.integrity: sha512-ySYCMk5nMIk3mZhDoxS0Dgxs6dnM5JBAOrEpwWDb1jLQCoxnXFBsanfHzbBSS3UIokpaS3ZNrocr22d2RIdQww==
41+
.unpackedSize: 1.9 MB
42+
43+
dependencies:
44+
@microsoft/node-core-library: 3.15.1 colors: ~1.2.1 uuid: ~3.1.0
45+
@types/es6-promise: 0.0.33 fs-extra: ~5.0.0 yeoman-generator: ~2.0.5
46+
@types/node: 8.10.54 lodash: ~4.17.5 yosay: ~1.1.1
47+
argparse: ~1.0.7 update-notifier: ~1.0.2
48+
49+
maintainers:
50+
- microsoft1es <[email protected]>
51+
- odspnpm <[email protected]>
52+
53+
dist-tags:
54+
latest: 1.11.0 next: 1.12.1-rc.0
55+
56+
published 9 months ago by odspnpm <[email protected]>
57+
```
58+
59+
In the sample output above, you can see the current released version is *1.11* while the developer preview version available is *1.12.1-rc.0*.
60+
61+
## How to install a developer preview version
62+
63+
To install a specific version of an NPM package, add `@` followed by the version number at the end of the package name.
64+
65+
For example, if the **info** command lists the **next** version is *10.11.12-rc.5*, you'd globally install the latest version of the generator with the following command:
66+
67+
```console
68+
npm install @microsoft/[email protected] --global
69+
```
70+
71+
> [!NOTE]
72+
> For more information on installing NPM packages, see the NPM documentation on [npm-install](https://docs.npmjs.com/cli/v7/commands/npm-install).
73+
74+
## Reporting issues
75+
76+
If during your testing you encounter an issue or bug with a developer preview release, please submit it to the [SharePoint/sp-dev-docs](https://aka.ms/spdev-issues) issue list. Make sure to indicate in your submission that the issue is about a specific preview release by including the version number in the title.

‎docs/spfx/release-1.12.1.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: SharePoint Framework v1.12.1 release notes
3+
description: Release notes for the SharePoint Framework v1.12.1 release
4+
ms.date: 04/13/2021
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
# SharePoint Framework v1.12.1 release notes
9+
10+
This release introduces a new property & event in the Web Part API to detect the rendering width (and changes), improved support for Microsoft Teams solutions, and updates supported versions of Node.js.
11+
12+
**Released:** TBD Q2, 2021
13+
14+
[!INCLUDE [spfx-release-candidate](../../includes/snippets/spfx-release-candidate.md)]
15+
16+
## Upgrading projects from v1.11.0 to v1.12.1
17+
18+
1. In the project's **package.json** file, identify all SPFx v1.11.0 packages. For each SPFx package:
19+
1. Uninstall the existing v1.11.0 package:
20+
21+
```console
22+
npm uninstall @microsoft/{spfx-package-name}@1.11.0
23+
```
24+
25+
1. Install the refreshed v1.12 {version-release} package:
26+
27+
```console
28+
npm install @microsoft/{spfx-package-name}@1.12.1 --save --save-exact
29+
```
30+
31+
> [!TIP]
32+
> The [CLI for Microsoft 365](https://aka.ms/o365cli) provides an easy step-by-step guidance to [upgrade](https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/) your solutions to latest SharePoint Framework version.
33+
34+
## New features and capabilities
35+
36+
- The **Sync to Teams** button in the Tenant App Catalog will use the Teams app manifest defined in the solution if present to create and publish a Teams app package to Microsoft Teams. If an app manifest file is not present, SharePoint will dynamically generate one.
37+
- *See [Deployment options for SharePoint Framework solutions for Microsoft Teams](deployment-spfx-teams-solutions.md) for more details.*
38+
- A new API has been added to the SPFx web part class to determine the rendered width of a web part and optionally handle an event when it changes.
39+
- *See [Determine the rendered web part size](web-parts/basics/determine-web-part-width.md) for more details.*
40+
- Preliminary support for Microsoft Teams meeting apps with the SharePoint Framework - full support is pending a fix for server side regression
41+
42+
## Changes in this release
43+
44+
- Add support for **Node.js v12.x & v14.x**
45+
- *See [Set up your SharePoint Framework development environment](set-up-your-development-environment.md) for details.*
46+
- **Gulp v4** (installed globally) is required (*see [Regarding Gulp versions & Node.js v12+](#gulp-versions--nodejs-v12) for details*)
47+
- For all projects:
48+
- Update the default version of TypeScript to **v3.7** (*via **@microsoft/rush-stack-compiler-3.7** v0.2.3*)
49+
- Update the **Gulp** version used to **v4.0.2**
50+
- For projects that use React:
51+
- Update the React NPM packages (**react** & **react-dom**) to **v16.9.0**.
52+
- Update the Office UI Fabric React NPM package / Microsoft Fluent UI (**office-ui-fabric-react**) to **v7.156.0**.
53+
54+
## Deprecations and removed items in this release
55+
56+
- **Gulp v3** is not supported (*neither globally nor locally installed*) when using Node.js v12+.
57+
- **Local workbench is deprecated** - This is the last release that will include support for the local workbench.
58+
- This is the last release that will include a single generator that works for on-prem and SharePoint Online. You'll still be able to create projects for on-prem, just by using the older generator.
59+
60+
### Gulp versions & Node.js v12+
61+
62+
Gulp v3 isn't supported with Node.js v12+ (*ref [gulpjs/gulp/#2324](https://github.com/gulpjs/gulp/issues/2324)*).
63+
64+
This is not a change with SPFx. Its mentioned here to bring attention to it as this SPFx release adds support for Node.js v12.

‎docs/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,8 @@
426426
items:
427427
- name: Overview
428428
href: spfx/roadmap.md
429+
- name: SPFx v1.12.1 (preview) - TBD Q2, 2021
430+
href: spfx/release-1.12.1.md
429431
- name: SPFx v1.11.0 - July 16, 2020
430432
href: spfx/release-1.11.0.md
431433
- name: SPFx v1.10.0 - January 7, 2020

‎includes/snippets/spfx-release-candidate.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
> [!CAUTION]
3+
> This version is currently available as a developer preview. Please consider this release as public beta made available for testing.
4+
>
5+
> For more information on determining if a developer preview release is available, and how to install it, see [SharePoint Framework developer preview releases](/sharepoint/dev/spfx/developer-preview-beta-features).
6+
>
7+
> For production environments, we recommend using the SPFx version referenced on [Set up your SharePoint Framework development environment](/sharepoint/dev/spfx/set-up-your-development-environment).

0 commit comments

Comments
 (0)