Skip to content

Commit e19ef64

Browse files
garrytrindergarrytrinder
authored
fix: use full semver in release notes filenames (#10855)
Rename 17 release notes files from release-1.X.md to release-1.X.0.md to use explicit semantic versioning. This helps AI coding agents identify the correct version-specific documentation when upgrading SPFx projects. Changes: - Renamed 17 files (1.1, 1.3-1.7, 1.13-1.23) - Updated version references within each renamed file - Updated TOC entries (name + href) - Added 17 redirect entries for old URLs - Updated 2 existing redirect targets - Updated ~40 cross-references across 22 files
1 parent 8f8fc8a commit e19ef64

41 files changed

Lines changed: 271 additions & 186 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openpublishing.redirection.json‎

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@
8787
},
8888
{
8989
"source_path": "docs/spfx/office-addins-create.md",
90-
"redirect_url": "/sharepoint/dev/spfx/release-1.14",
90+
"redirect_url": "/sharepoint/dev/spfx/release-1.14.0",
9191
"redirect_document_id": false
9292
},
9393
{
9494
"source_path": "docs/spfx/web-parts/get-started/office-addins-tutorial.md",
95-
"redirect_url": "/sharepoint/dev/spfx/release-1.14",
95+
"redirect_url": "/sharepoint/dev/spfx/release-1.14.0",
9696
"redirect_document_id": false
9797
},
9898
{
@@ -274,6 +274,91 @@
274274
"source_path": "docs/spfx/office-ui-fabric-integration.md",
275275
"redirect_url": "/sharepoint/dev/spfx/fluent-ui-integration",
276276
"redirect_document_id": false
277+
},
278+
{
279+
"source_path": "docs/spfx/release-1.1.md",
280+
"redirect_url": "/sharepoint/dev/spfx/release-1.1.0",
281+
"redirect_document_id": false
282+
},
283+
{
284+
"source_path": "docs/spfx/release-1.3.md",
285+
"redirect_url": "/sharepoint/dev/spfx/release-1.3.0",
286+
"redirect_document_id": false
287+
},
288+
{
289+
"source_path": "docs/spfx/release-1.4.md",
290+
"redirect_url": "/sharepoint/dev/spfx/release-1.4.0",
291+
"redirect_document_id": false
292+
},
293+
{
294+
"source_path": "docs/spfx/release-1.5.md",
295+
"redirect_url": "/sharepoint/dev/spfx/release-1.5.0",
296+
"redirect_document_id": false
297+
},
298+
{
299+
"source_path": "docs/spfx/release-1.6.md",
300+
"redirect_url": "/sharepoint/dev/spfx/release-1.6.0",
301+
"redirect_document_id": false
302+
},
303+
{
304+
"source_path": "docs/spfx/release-1.7.md",
305+
"redirect_url": "/sharepoint/dev/spfx/release-1.7.0",
306+
"redirect_document_id": false
307+
},
308+
{
309+
"source_path": "docs/spfx/release-1.13.md",
310+
"redirect_url": "/sharepoint/dev/spfx/release-1.13.0",
311+
"redirect_document_id": false
312+
},
313+
{
314+
"source_path": "docs/spfx/release-1.14.md",
315+
"redirect_url": "/sharepoint/dev/spfx/release-1.14.0",
316+
"redirect_document_id": false
317+
},
318+
{
319+
"source_path": "docs/spfx/release-1.15.md",
320+
"redirect_url": "/sharepoint/dev/spfx/release-1.15.0",
321+
"redirect_document_id": false
322+
},
323+
{
324+
"source_path": "docs/spfx/release-1.16.md",
325+
"redirect_url": "/sharepoint/dev/spfx/release-1.16.0",
326+
"redirect_document_id": false
327+
},
328+
{
329+
"source_path": "docs/spfx/release-1.17.md",
330+
"redirect_url": "/sharepoint/dev/spfx/release-1.17.0",
331+
"redirect_document_id": false
332+
},
333+
{
334+
"source_path": "docs/spfx/release-1.18.md",
335+
"redirect_url": "/sharepoint/dev/spfx/release-1.18.0",
336+
"redirect_document_id": false
337+
},
338+
{
339+
"source_path": "docs/spfx/release-1.19.md",
340+
"redirect_url": "/sharepoint/dev/spfx/release-1.19.0",
341+
"redirect_document_id": false
342+
},
343+
{
344+
"source_path": "docs/spfx/release-1.20.md",
345+
"redirect_url": "/sharepoint/dev/spfx/release-1.20.0",
346+
"redirect_document_id": false
347+
},
348+
{
349+
"source_path": "docs/spfx/release-1.21.md",
350+
"redirect_url": "/sharepoint/dev/spfx/release-1.21.0",
351+
"redirect_document_id": false
352+
},
353+
{
354+
"source_path": "docs/spfx/release-1.22.md",
355+
"redirect_url": "/sharepoint/dev/spfx/release-1.22.0",
356+
"redirect_document_id": false
357+
},
358+
{
359+
"source_path": "docs/spfx/release-1.23.md",
360+
"redirect_url": "/sharepoint/dev/spfx/release-1.23.0",
361+
"redirect_document_id": false
277362
}
278363
]
279364
}

‎docs/spfx/compatibility.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,26 +47,26 @@ The following table lists the SPFx and compatible versions of common tools and l
4747
| ------------------------------- | ------------- | -------------- | ----------- |
4848
| [1.22.2](release-1.22.2.md) | v22 | v2.9 - v5.8 | v17.0.1 |
4949
| [1.22.1](release-1.22.1.md) | v22 | v2.9 - v5.8 | v17.0.1 |
50-
| [1.22.0](release-1.22.md) | v22 | v2.9 - v5.8 | v17.0.1 |
50+
| [1.22.0](release-1.22.0.md) | v22 | v2.9 - v5.8 | v17.0.1 |
5151
| [1.21.1](release-1.21.1.md) | v22 | v5.3 | v17.0.1 |
52-
| [1.21.0](release-1.21.md) | v22 | v5.3 | v17.0.1 |
53-
| [1.20.0](release-1.20.md) | v18 | v4.5, v4.7 | v17.0.1 |
54-
| [1.19.0](release-1.19.md) | v18 | v4.5, v4.7 | v17.0.1 |
52+
| [1.21.0](release-1.21.0.md) | v22 | v5.3 | v17.0.1 |
53+
| [1.20.0](release-1.20.0.md) | v18 | v4.5, v4.7 | v17.0.1 |
54+
| [1.19.0](release-1.19.0.md) | v18 | v4.5, v4.7 | v17.0.1 |
5555
| [1.18.2](release-1.18.2.md) | v16, v18 | v4.5, v4.7 | v17.0.1 |
5656
| [1.18.1](release-1.18.1.md) | v16, v18 | v4.5, v4.7 | v17.0.1 |
57-
| [1.18](release-1.18.md) | v16, v18 | v4.5, v4.7 | v17.0.1 |
57+
| [1.18](release-1.18.0.md) | v16, v18 | v4.5, v4.7 | v17.0.1 |
5858
| [1.17.4](release-1.17.4.md) | v16.13+ | v4.5 | v17.0.1 |
5959
| [1.17.3](release-1.17.3.md) | v16.13+ | v4.5 | v17.0.1 |
6060
| [1.17.2](release-1.17.2.md) | v16.13+ | v4.5 | v17.0.1 |
6161
| [1.17.1](release-1.17.1.md) | v16.13+ | v4.5 | v17.0.1 |
62-
| [1.17.0](release-1.17.md) | v16.13+ | v4.5 | v17.0.1 |
62+
| [1.17.0](release-1.17.0.md) | v16.13+ | v4.5 | v17.0.1 |
6363
| [1.16.1](release-1.16.1.md) | v16.13+ | v4.5 | v17.0.1 |
64-
| [1.16.0](release-1.16.md) | v16.13+ | v4.5 | v17.0.1 |
64+
| [1.16.0](release-1.16.0.md) | v16.13+ | v4.5 | v17.0.1 |
6565
| [1.15.2](release-1.15.2.md) | v12, v14, v16 | v4.5 | v16.13.1 |
66-
| [1.15.0](release-1.15.md) | v12, v14, v16 | v4.5 | v16.13.1 |
67-
| [1.14.0](release-1.14.md) | v12, v14 | v3.9 | v16.13.1 |
66+
| [1.15.0](release-1.15.0.md) | v12, v14, v16 | v4.5 | v16.13.1 |
67+
| [1.14.0](release-1.14.0.md) | v12, v14 | v3.9 | v16.13.1 |
6868
| [1.13.1](release-1.13.1.md) | v12, v14 | v3.9 | v16.13.1 |
69-
| [1.13.0](release-1.13.md) | v12, v14 | v3.9 | v16.13.1 |
69+
| [1.13.0](release-1.13.0.md) | v12, v14 | v3.9 | v16.13.1 |
7070
| [1.12.1](release-1.12.1.md) | v10, v12, v14 | v3.7 | v16.9.0 |
7171
| ~~[1.12.0](release-1.12.0.md)~~ | ~~v12, v10~~ | ~~v3.7~~ | ~~v16.9.0~~ |
7272
| [1.11.0](release-1.11.0.md) | v10 | v3.3 | v16.8.5 |
@@ -76,20 +76,20 @@ The following table lists the SPFx and compatible versions of common tools and l
7676
| [1.8.1](release-1.8.1.md) | v8 | v2.7, v2.9, v3 | v16.7.0 |
7777
| [1.8.0](release-1.8.0.md) | v8 | v2.7, v2.9, v3 | v16.7.0 |
7878
| [1.7.1](release-1.7.1.md) | v8 | v2.4 | v16.3.2 |
79-
| [1.7.0](release-1.7.md) | v8 | v2.4 | v16.3.2 |
80-
| [1.6.0](release-1.6.md) | v6, v8 | v2.4 | v15 |
79+
| [1.7.0](release-1.7.0.md) | v8 | v2.4 | v16.3.2 |
80+
| [1.6.0](release-1.6.0.md) | v6, v8 | v2.4 | v15 |
8181
| [1.5.1](release-1.5.1.md) | v6, v8 | v2.4 | v15 |
82-
| [1.5.0](release-1.5.md) | v6, v8 | v2.4 | v15 |
82+
| [1.5.0](release-1.5.0.md) | v6, v8 | v2.4 | v15 |
8383
| [1.4.1](release-1.4.1.md) | v6, v8 | v2.4 | v15 |
84-
| [1.4.0](release-1.4.md) | v6 | v2.4 | v15 |
85-
| [1.3.0](release-1.3.md) | v6 | v2.4 | v15 |
86-
| [1.1.0](release-1.1.md) | v6 | v2.4 | v15 |
84+
| [1.4.0](release-1.4.0.md) | v6 | v2.4 | v15 |
85+
| [1.3.0](release-1.3.0.md) | v6 | v2.4 | v15 |
86+
| [1.1.0](release-1.1.0.md) | v6 | v2.4 | v15 |
8787
| [1.0.0](release-1.0.0.md) | v6 | v2.4 | v15 |
8888
8989
> [!IMPORTANT]
9090
> The SPFx introduced a significant change to the build toolchain starting with the SPFx v1.22 release. The legacy gulp-based toolchain (legacy) was used from SPFx v1.0 - v1.21.1. Learn more in the following articles:
9191
>
92-
> - [SPFx v1.22 release notes](release-1.22.md)
92+
> - [SPFx v1.22 release notes](release-1.22.0.md)
9393
> - [Gulp-based Toolchain (legacy)](toolchain/sharepoint-framework-toolchain.md)
9494
> - [Heft-based toolchain (SPFx v1.22.0+)](toolchain/sharepoint-framework-toolchain-rushstack-heft.md)
9595

‎docs/spfx/extensions/basics/tenant-wide-deployment-extensions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ This file contains by default following structure. **ClientSideComponentInstance
103103
If you selected **SharePoint Online only (latest)** as the target environment selected when the SharePoint Framework solution was created, the **ClientSideInstance.xml** file is also referenced in the **package-solution.json**, so that it's included inside of the **\*.sppkg** file, when you package your solution.
104104

105105
> [!IMPORTANT]
106-
> If you select another target environment, while the the **ClientSideInstance.xml** file is added to the project, it isn't included in the **package-solution.json** file. While SharePoint Server 2019 (*that includes the SharePoint Framework v1.4, see [Supported capabilities](../../../general-development/sharepoint-2019-development-platform.md#supported-capabilities) for details*) supports tenant scoped deployment, it doesn't support tenant-wide deployment (*added in SharePoint Framework v1.6, see [Tenant-Wide Deployment of extensions](../../release-1.6.md#tenant-wide-deployment-of-extensions) for details*).
106+
> If you select another target environment, while the the **ClientSideInstance.xml** file is added to the project, it isn't included in the **package-solution.json** file. While SharePoint Server 2019 (*that includes the SharePoint Framework v1.4, see [Supported capabilities](../../../general-development/sharepoint-2019-development-platform.md#supported-capabilities) for details*) supports tenant scoped deployment, it doesn't support tenant-wide deployment (*added in SharePoint Framework v1.6, see [Tenant-Wide Deployment of extensions](../../release-1.6.0.md#tenant-wide-deployment-of-extensions) for details*).
107107
>
108108
> If this file is referenced in the **package-solution.json**, uploading the generated **\*.sppkg** file to the SharePoint Server 2019 tenant app catalog will throw an exception.
109109

‎docs/spfx/extensions/get-started/building-form-customizer.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom: scenarios:getting-started
1010
Form customizers are SharePoint Framework components that give you an option to override the form experience at a list or library level by associating the component with the used content type. Form customizer components can be used in SharePoint Online, and you build them using modern JavaScript tools and libraries.
1111

1212
> [!IMPORTANT]
13-
> Form customizers were released as part of the SharePoint Framework v1.15, so ensure that you are using the right version in your environment. See [v1.15 release notes](../../release-1.15.md) for details.
13+
> Form customizers were released as part of the SharePoint Framework v1.15, so ensure that you are using the right version in your environment. See [v1.15 release notes](../../release-1.15.0.md) for details.
1414
1515
> [!TIP]
1616
> You can find the output from this tutorial from [GitHub](https://github.com/pnp/spfx-reference-scenarios/tree/main/samples/spfx-formcustomizer-basics).

‎docs/spfx/extensions/guidance/list-view-command-set-grouping.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.localizationpriority: medium
1111

1212
# Grouping support with ListView Command Set extension
1313

14-
Starting from the [SharePoint Framework v1.23](../../release-1.23.md), [ListView Command Sets](../get-started/building-simple-cmdset-with-dialog-api.md) also support grouping. You can use `group` element and cross item associations in the ListView Command Set manifest to build a hierarchy of commands that are then grouped in the list and library toolbar and context menu.
14+
Starting from the [SharePoint Framework v1.23](../../release-1.23.0.md), [ListView Command Sets](../get-started/building-simple-cmdset-with-dialog-api.md) also support grouping. You can use `group` element and cross item associations in the ListView Command Set manifest to build a hierarchy of commands that are then grouped in the list and library toolbar and context menu.
1515

1616
[!INCLUDE [spfx-prerelease-related](../../../../includes/snippets/spfx-prerelease-related.md)]
1717

‎docs/spfx/integrate-with-teams-introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ this.context.sdks.microsoftTeams.teamsJs.app.getContext()
118118
> The process of obtaining the Microsoft Teams context with the SPFx API has changed a few times over time. For example, you may be familiar with the following properties that would return the Microsoft Teams context:
119119
>
120120
> - The property `this.context.microsoftTeams` was [deprecated in the SharePoint Framework v1.10 release](release-1.10.0.md).
121-
> - The property `this.context.sdks.microsoftTeams` was [deprecated in the SharePoint Framework v1.16 release](release-1.16.md).
121+
> - The property `this.context.sdks.microsoftTeams` was [deprecated in the SharePoint Framework v1.16 release](release-1.16.0.md).
122122
123123
## What Teams JavaScript client SDK version to use?
124124

docs/spfx/release-1.1.md renamed to docs/spfx/release-1.1.0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: SharePoint Framework v1.1 release notes
3-
description: Release notes for the SharePoint Framework v1.1 release
2+
title: SharePoint Framework v1.1.0 release notes
3+
description: Release notes for the SharePoint Framework v1.1.0 release
44
ms.date: 09/08/2021
55
ms.localizationpriority: high
66
---
7-
# SharePoint Framework v1.1 release notes
7+
# SharePoint Framework v1.1.0 release notes
88

99
This release introduces the developer preview of extensions.
1010

1111
**Released:** June 6, 2017
1212

1313
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
1414

15-
## Upgrading projects from v1.0 to v1.1
15+
## Upgrading projects from v1.0 to v1.1.0
1616

1717
In the project's **package.json** file, identify all SPFx v1.0 packages. For each SPFx package:
1818

@@ -22,7 +22,7 @@ In the project's **package.json** file, identify all SPFx v1.0 packages. For eac
2222
npm uninstall @microsoft/{spfx-package-name}@1.0
2323
```
2424

25-
1. Install the refreshed v1.1 package:
25+
1. Install the refreshed v1.1.0 package:
2626

2727
```console
2828
npm install @microsoft/{spfx-package-name}@1.1.0 --save --save-exact

docs/spfx/release-1.13.md renamed to docs/spfx/release-1.13.0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: SharePoint Framework v1.13 release notes
3-
description: Release notes for the SharePoint Framework v1.13 release
2+
title: SharePoint Framework v1.13.0 release notes
3+
description: Release notes for the SharePoint Framework v1.13.0 release
44
ms.date: 10/25/2021
55
ms.localizationpriority: high
66
---
7-
# SharePoint Framework v1.13 release notes
7+
# SharePoint Framework v1.13.0 release notes
88

99
This release introduces a new component type, Adaptive Card Extensions (ACE), that can be used to extend Viva Connections.
1010

1111
**Released:** October 21, 2021
1212

1313
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
1414

15-
## Upgrading projects from v1.12.1 to v1.13
15+
## Upgrading projects from v1.12.1 to v1.13.0
1616

1717
In the project's **package.json** file, identify all SPFx v1.12.1 packages. For each SPFx package:
1818

@@ -22,7 +22,7 @@ In the project's **package.json** file, identify all SPFx v1.12.1 packages. For
2222
npm uninstall @microsoft/{spfx-package-name}@1.12.1
2323
```
2424

25-
1. Install the refreshed v1.13 {version-release} package:
25+
1. Install the refreshed v1.13.0 {version-release} package:
2626

2727
```console
2828
npm install @microsoft/{spfx-package-name}@1.13.0 --save --save-exact

docs/spfx/release-1.14.md renamed to docs/spfx/release-1.14.0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: SharePoint Framework v1.14 release notes
3-
description: Release notes for the SharePoint Framework v1.14 release
2+
title: SharePoint Framework v1.14.0 release notes
3+
description: Release notes for the SharePoint Framework v1.14.0 release
44
ms.date: 03/08/2023
55
ms.localizationpriority: high
66
---
7-
# SharePoint Framework v1.14 release notes
7+
# SharePoint Framework v1.14.0 release notes
88

99
This release introduces updates across the features around Microsoft Viva, Microsoft Teams and SharePoint.
1010

1111
**Released:** February 17, 2022
1212

1313
[!INCLUDE [spfx-release-notes-common](../../includes/snippets/spfx-release-notes-common.md)]
1414

15-
## Upgrading projects from v1.13.1 to v1.14
15+
## Upgrading projects from v1.13.1 to v1.14.0
1616

1717
In the project's **package.json** file, identify all SPFx v1.13.1 packages. For each SPFx package:
1818

@@ -22,7 +22,7 @@ In the project's **package.json** file, identify all SPFx v1.13.1 packages. For
2222
npm uninstall @microsoft/{spfx-package-name}@1.13.1
2323
```
2424

25-
1. Install the new v1.14 package:
25+
1. Install the new v1.14.0 package:
2626

2727
```console
2828
npm install @microsoft/{spfx-package-name}@1.14.0 --save --save-exact
@@ -157,7 +157,7 @@ This property will be explicitly used to wind up the server, meaning all debug U
157157

158158
## Preview Features and Capabilities
159159

160-
Following features are still in preview status as part of the 1.14 release and should not be used in production. We are looking into releasing them officially as part of the upcoming 1.15 release.
160+
Following features are still in preview status as part of the 1.14.0 release and should not be used in production. We are looking into releasing them officially as part of the upcoming 1.15 release.
161161

162162
### Adaptive Card Extensions Card View caching
163163

0 commit comments

Comments
 (0)