Build fails when setting skipFeatureDeployment to true

[barisbikmaz]

Target SharePoint environment

SharePoint Online

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

Windows

What browser(s) / client(s) have you tested

• 💥 Internet Explorer
• 💥 Microsoft Edge
• 💥 Google Chrome
• 💥 FireFox
• 💥 Safari
• mobile (iOS/iPadOS)
• mobile (Android)
• not applicable
• other (enter in the "Additional environment details" area below)

Additional environment details

• SPFx version: 1.12.1
• Node.js version: 14.17.0

Describe the bug / error

I have a solution which I want to install tenant-wide. Therefore I have set "skipFeatureDeployment" property to "true".
When I run the command "gulp package-solution --ship" I get a warning

Admins can make this solution available to all sites immediately, but the solution also contains feature.xml elements for provisioning. Feature.xml elements are not automatically applied unless the solution is explicitly installed on a site.

which results in an npm error and causes our CI pipeline to fail.

Steps to reproduce

1. Goto package-solution.json
2. Set skipFeatureDeployment to "true"
3. run "gulp package-solution --ship"

My package-solution.json

{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
  "solution": {
    "name": "My Solution Name",
    "id": "13aa1234-5555-4455-aaaa-1a2eab3f4567",
    "iconPath": "assets/icons/app-icon.png",
    "version": "1.0.0.0",
    "includeClientSideAssets": true,
    "skipFeatureDeployment": true,
    "features": [
      {
        "title": "My cool feature",
        "description": "Deploys a command button for document libraries.",
        "id": "2b8fcbc1-5aa7-4ac7-8e5f-74378d2119fb",
        "version": "1.0.0.0",
        "assets": {
          "elementManifests": [
            "elements.xml",
            "clientsideinstance.xml"
          ]
        }
      }
    ],
    "developer": {
      ....
    }
  },
  "paths": {
    "zippedPackage": "solution/my-solution.sppkg"
  }
}

package.json

"dependencies": {
   "@microsoft/decorators": "1.12.1",
   "@microsoft/sp-core-library": "1.12.1",
   "@microsoft/sp-dialog": "1.12.1",
   "@microsoft/sp-listview-extensibility": "1.12.1",
   "@pnp/sp": "^2.9.0",
   "@types/webpack-env": "^1.16.2"
 },
 "devDependencies": {
   "@microsoft/rush-stack-compiler-3.7": "0.6.47",
   "@microsoft/sp-build-web": "1.12.1",
   "@microsoft/sp-module-interfaces": "1.12.1",
   "@microsoft/sp-tslint-rules": "1.12.1",
   "@microsoft/sp-webpart-workbench": "1.12.1",
   "@types/chai": "4.2.22",
   "@types/jest": "24.0.24",
   "@types/mocha": "9.0.0",
   "@voitanos/jest-preset-spfx-react16": "^1.5.0",
   "ajv": "~8.6.3",
   "gulp": "^4.0.2",
   "jest": "24.9.0",
   "ts-jest": "24.2.0",
   "typescript": "3.7.7"
 }

Expected behavior

Setting skipFeatureDeployment property to true should not fail build.

[patmill]

Right, so the way you have this set up currently is that you have an extension that has feature XML (your elements.xml file). This basically says "add this element to a site when the app is deployed to it, because the element controls registration". However, you have also said "you don't need to deploy this app to a site". The warning is pointing out the discrepancy.

[barisbikmaz]

@patmill Sorry I don't really get it. What can I do now to build a solution that an admin can deploy tenant-wide without an npm error?

My Reference is here : tenant-scoped-deployment and the config looks the same as mine.

[AJIXuMuK]

Hi @barisbikmaz - do you have some custom CI pipeline that fails if there are warnings in the console?

We do use warning to provide some important information. In your scenario, as @patmill mentioned, we inform that you have Feature Framework elements in tenant-wide solution.

[barisbikmaz]

@AJIXuMuK Yes my CI pipeline fails because of this warning. As you can see in my previous comment npm sends an error code 1.

At the moment I have added a build supression to gulpfile.js:

• build.addSuppression(/Admins can make this solution available to all sites immediately.*/);

[barisbikmaz]

@AJIXuMuK Sorry my build does not fail although it says that it has failed. 🤔

[AJIXuMuK]

@barisbikmaz - seems like the pipeline doesn't like warnings.

We'll be working to write warning in more specific situation (when there is a tenant-wide deployment, elements.xml file and web parts only).
Probably, it'll make things better for you.

But I would also check settings to disable failing on warning output.

[AJIXuMuK]

@barisbikmaz - the promised changes were included in the 1.14 beta.

[ghost]

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues