You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update notes on SharePoint solution packaging (#10709)
* Update notes on SharePoint solution packaging
feature / component 1:1 mapping
* Revise notes on SharePoint solution packaging
Updated the date and modified the content for clarity and accuracy.
---------
Co-authored-by: Andrew Connell <me@andrewconnell.com>
Copy file name to clipboardExpand all lines: docs/spfx/web-parts/basics/notes-on-solution-packaging.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
title: SharePoint solution packaging
3
3
description: The package-solution gulp task looks at /config/package-solution.json for various configuration details in SharePoint Framework, including ISolution and IFeature definitions.
4
-
ms.date: 10/01/2025
4
+
ms.date: 03/11/2026
5
5
ms.localizationpriority: high
6
6
---
7
7
# SharePoint solution packaging
8
8
9
-
The **package-solution** gulp task looks at **./config/package-solution.json** for various configuration details, including some generic filepaths, and defining the relationship between components (*WebParts* and *Applications*) in a package.
9
+
The **package-solution** gulp task looks at **./config/package-solution.json** for various configuration details, including some generic filepaths, and defines the relationship between components (*WebParts* and *Applications*) in a package.
10
10
11
11
The schema for the configuration file is as follows:
Each package configuration file has some optional settings to override the places where the task looks for various source files and manifests, and defining the location to write the package. Additionally, it has a required solution definition, which instructs the packager on the relationships of various components.
28
+
Each package configuration file has some optional settings to override the places where the task looks for various source files and manifests, and define the location to write the package. Additionally, it has a required solution definition, which instructs the packager on the relationships of various components.
29
29
30
30
## Solution definition (ISolution)
31
31
@@ -42,15 +42,15 @@ interface ISolution {
42
42
}
43
43
```
44
44
45
-
Each solution file must have a `name` that identifies the package in the SharePoint UI. Additionally, each package must contain a globally unique identifier (`id`), which is used internally by SharePoint. Optionally, you may also specify a `version`number in the format "X.X.X.X", which is used to identify various versions of the package when upgrading.
45
+
Each solution file must have a `name` that identifies the package in the SharePoint UI. Additionally, each package must include a globally unique identifier (`id`)used internally by SharePoint. Optionally, you may specify a `version` in the format "X.X.X.X"to identify package versions during upgrades.
46
46
47
47
> [!NOTE]
48
48
> The versioning system only applies to Feature Framework and SharePoint Feature definitions included in the package. Code and assets from the new version of the package are available as soon as the new version of the package is added to App Catalog, with no need to update the app on sites.
49
49
50
50
The solution definition also optionally contains a list of SharePoint Feature definitions.
51
51
52
52
> [!NOTE]
53
-
> If the `features` property is omitted, the task creates a single Feature for every component (a 1:1 mapping). An empty array will produce no features, and the web parts will not be added.
53
+
> If the `features` property is omitted, the task creates a single Feature for every component (a 1:1 mapping). An empty array produces no features, and the web parts are not added.
54
54
55
55
## Feature definition (IFeature)
56
56
@@ -66,9 +66,9 @@ interface IFeature {
66
66
}
67
67
```
68
68
69
-
It's important to note that this is a definition for creating a SharePoint feature, and that some of these options are exposed in the UI. Similarly to the solution, each feature has a mandatory `title`, `description`, `id`, and `version` number (in the X.X.X.X format). The feature `id` should also be a globally unique identifier.
69
+
It's important to note that this is a definition for creating a SharePoint feature, and that some of these options are exposed in the UI. As with the solution, each feature has a mandatory `title`, `description`, `id`, and `version` (in the X.X.X.X format). The feature `id` should also be a globally unique identifier.
70
70
71
-
Each feature can also contain any number of components that are activated when the feature is activated. This is defined via a list of `componentIds`, which are globally unique identifiers that *must* match the **ID** in the component's manifest file. If this list is undefined or empty, the packager includes *every* component in the feature.
71
+
Each feature can also contain any number of components that are activated when the feature is activated. This is defined via a list of `componentIds`, which are globally unique identifiers that *must* match the `ID` in the component's manifest file. If this list is undefined or empty, the packager includes *every* component in the feature. Any given `componentId` may only belong to one feature.
To support provisioning of various SharePoint resources (such as List Templates, Pages, or Content Types), custom feature XML may also be injected into the package. This is used to provision resources necessary for applications, but may also be used for web parts. The documentation for Feature XML is located at [Feature.xml Files](https://msdn.microsoft.com/library/office/ms475601.aspx?f=255&MSPPError=-2147217396).
121
+
To support provisioning of various SharePoint resources (such as List Templates, Pages, or Content Types), custom feature XML may also be injected into the package. This is used to provision resources necessary for applications, but may also be used for web parts. The documentation for Feature XML is located at [Feature.xml Files](../../../schema/feature-xml-files.md).
122
122
123
123
The packaging task looks for the custom feature XML in **./sharepoint/feature\_xml**. Every file in this folder is included in the final application package. However, the task relies on the contents of the **\_rels/** folder to determine which custom features are defined.
0 commit comments