@pnp/cli-microsoft365 6.11.0-beta.1b96aef → 6.11.0-beta.2d03676

package/dist/m365/spfx/commands/project/DeployWorkflow.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workflow = void 0;
+exports.workflow = {
+    name: "Deploy Solution {{ name }}",
+    on: {
+        push: {
+            branches: [
+                "main"
+            ]
+        }
+    },
+    jobs: {
+        "build-and-deploy": {
+            "runs-on": "ubuntu-latest",
+            steps: [
+                {
+                    name: "Checkout",
+                    uses: "actions/checkout@v3.5.3"
+                },
+                {
+                    name: "Use Node.js 16.x",
+                    uses: "actions/setup-node@v3.7.0",
+                    with: {
+                        "node-version": "16.x"
+                    }
+                },
+                {
+                    name: "Run npm ci",
+                    run: "npm ci"
+                },
+                {
+                    name: "Bundle & Package",
+                    run: "gulp bundle --ship\ngulp package-solution --ship\n"
+                },
+                {
+                    name: "CLI for Microsoft 365 Login",
+                    uses: "pnp/action-cli-login@v2.2.2",
+                    with: {
+                        "CERTIFICATE_ENCODED": "${{ secrets.CERTIFICATE_ENCODED }}",
+                        "CERTIFICATE_PASSWORD": "${{ secrets.CERTIFICATE_PASSWORD }}",
+                        "APP_ID": "${{ secrets.APP_ID }}"
+                    }
+                },
+                {
+                    name: "CLI for Microsoft 365 Deploy App",
+                    uses: "pnp/action-cli-deploy@v3.0.1",
+                    with: {
+                        "APP_FILE_PATH": "sharepoint/solution/{{ solutionName }}.sppkg",
+                        "SKIP_FEATURE_DEPLOYMENT": false,
+                        "OVERWRITE": false
+                    }
+                }
+            ]
+        }
+    }
+};
+//# sourceMappingURL=DeployWorkflow.js.map

package/dist/m365/spfx/commands/project/project-github-workflow-add.js

@@ -0,0 +1,171 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpfxProjectGithubWorkflowAddCommand_instances, _SpfxProjectGithubWorkflowAddCommand_initTelemetry, _SpfxProjectGithubWorkflowAddCommand_initOptions, _SpfxProjectGithubWorkflowAddCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const yaml = require("yaml");
+const Command_1 = require("../../../../Command");
+const fsUtil_1 = require("../../../../utils/fsUtil");
+const validation_1 = require("../../../../utils/validation");
+const commands_1 = require("../../commands");
+const DeployWorkflow_1 = require("./DeployWorkflow");
+const base_project_command_1 = require("./base-project-command");
+class SpfxProjectGithubWorkflowAddCommand extends base_project_command_1.BaseProjectCommand {
+    get name() {
+        return commands_1.default.PROJECT_GITHUB_WORKFLOW_ADD;
+    }
+    get description() {
+        return 'Adds a GitHub workflow for a SharePoint Framework project.';
+    }
+    constructor() {
+        super();
+        _SpfxProjectGithubWorkflowAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpfxProjectGithubWorkflowAddCommand_instances, "m", _SpfxProjectGithubWorkflowAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpfxProjectGithubWorkflowAddCommand_instances, "m", _SpfxProjectGithubWorkflowAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpfxProjectGithubWorkflowAddCommand_instances, "m", _SpfxProjectGithubWorkflowAddCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.projectRootPath = this.getProjectRoot(process.cwd());
+            if (this.projectRootPath === null) {
+                throw new Command_1.CommandError(`Couldn't find project root folder`, SpfxProjectGithubWorkflowAddCommand.ERROR_NO_PROJECT_ROOT_FOLDER);
+            }
+            const solutionPackageJsonFile = path.join(this.projectRootPath, 'package.json');
+            const packageJson = fs.readFileSync(solutionPackageJsonFile, 'utf-8');
+            const solutionName = JSON.parse(packageJson).name;
+            if (this.debug) {
+                logger.logToStderr(`Adding GitHub workflow in the current SPFx project`);
+            }
+            try {
+                this.updateWorkflow(solutionName, DeployWorkflow_1.workflow, args.options);
+                this.saveWorkflow(DeployWorkflow_1.workflow);
+            }
+            catch (error) {
+                throw new Command_1.CommandError(error);
+            }
+        });
+    }
+    saveWorkflow(workflow) {
+        const githubPath = path.join(this.projectRootPath, '.github');
+        fsUtil_1.fsUtil.ensureDirectory(githubPath);
+        const workflowPath = path.join(githubPath, 'workflows');
+        fsUtil_1.fsUtil.ensureDirectory(workflowPath);
+        const workflowFile = path.join(workflowPath, 'deploy-spfx-solution.yml');
+        fs.writeFileSync(path.resolve(workflowFile), yaml.stringify(workflow), 'utf-8');
+    }
+    updateWorkflow(solutionName, workflow, options) {
+        var _a;
+        workflow.name = workflow.name.replace('{{ name }}', (_a = options.name) !== null && _a !== void 0 ? _a : solutionName);
+        if (options.branchName) {
+            workflow.on.push.branches[0] = options.branchName;
+        }
+        if (options.manuallyTrigger) {
+            // eslint-disable-next-line camelcase
+            workflow.on.workflow_dispatch = null;
+        }
+        if (options.skipFeatureDeployment) {
+            this.getDeployAction(workflow).with.SKIP_FEATURE_DEPLOYMENT = true;
+        }
+        if (options.overwrite) {
+            this.getDeployAction(workflow).with.OVERWRITE = true;
+        }
+        if (options.loginMethod === 'user') {
+            const loginAction = this.getLoginAction(workflow);
+            loginAction.with = {
+                ADMIN_USERNAME: '${{ secrets.ADMIN_USERNAME }}',
+                ADMIN_PASSWORD: '${{ secrets.ADMIN_PASSWORD }}'
+            };
+        }
+        if (options.scope === 'sitecollection') {
+            const deployAction = this.getDeployAction(workflow);
+            deployAction.with.SCOPE = 'sitecollection';
+            deployAction.with.SITE_COLLECTION_URL = options.siteUrl;
+        }
+        if (solutionName) {
+            const deployAction = this.getDeployAction(workflow);
+            deployAction.with.APP_FILE_PATH = deployAction.with.APP_FILE_PATH.replace('{{ solutionName }}', solutionName);
+        }
+    }
+    getLoginAction(workflow) {
+        const steps = this.getWorkFlowSteps(workflow);
+        return steps.find(step => step.uses && step.uses.indexOf('action-cli-login') >= 0);
+    }
+    getDeployAction(workflow) {
+        const steps = this.getWorkFlowSteps(workflow);
+        return steps.find(step => step.uses && step.uses.indexOf('action-cli-deploy') >= 0);
+    }
+    getWorkFlowSteps(workflow) {
+        return workflow.jobs['build-and-deploy'].steps;
+    }
+}
+_SpfxProjectGithubWorkflowAddCommand_instances = new WeakSet(), _SpfxProjectGithubWorkflowAddCommand_initTelemetry = function _SpfxProjectGithubWorkflowAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            name: typeof args.options.name !== 'undefined',
+            branchName: typeof args.options.branchName !== 'undefined',
+            manuallyTrigger: !!args.options.manuallyTrigger,
+            loginMethod: typeof args.options.loginMethod !== 'undefined',
+            scope: typeof args.options.scope !== 'undefined',
+            skipFeatureDeployment: !!args.options.skipFeatureDeployment,
+            overwrite: !!args.options.overwrite
+        });
+    });
+}, _SpfxProjectGithubWorkflowAddCommand_initOptions = function _SpfxProjectGithubWorkflowAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-n, --name [name]'
+    }, {
+        option: '-b, --branchName [branchName]'
+    }, {
+        option: '-m, --manuallyTrigger'
+    }, {
+        option: '-l, --loginMethod [loginMethod]',
+        autocomplete: SpfxProjectGithubWorkflowAddCommand.loginMethod
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: SpfxProjectGithubWorkflowAddCommand.scope
+    }, {
+        option: '-u, --siteUrl [siteUrl]'
+    }, {
+        option: '--skipFeatureDeployment'
+    }, {
+        option: '--overwrite'
+    });
+}, _SpfxProjectGithubWorkflowAddCommand_initValidators = function _SpfxProjectGithubWorkflowAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.scope && args.options.scope === 'sitecollection') {
+            if (!args.options.siteUrl) {
+                return `siteUrl option has to be defined when scope set to ${args.options.scope}`;
+            }
+            const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.siteUrl);
+            if (isValidSharePointUrl !== true) {
+                return isValidSharePointUrl;
+            }
+        }
+        if (args.options.loginMethod && SpfxProjectGithubWorkflowAddCommand.loginMethod.indexOf(args.options.loginMethod) < 0) {
+            return `${args.options.loginMethod} is not a valid login method. Allowed values are ${SpfxProjectGithubWorkflowAddCommand.loginMethod.join(', ')}`;
+        }
+        if (args.options.scope && SpfxProjectGithubWorkflowAddCommand.scope.indexOf(args.options.scope) < 0) {
+            return `${args.options.scope} is not a valid scope. Allowed values are ${SpfxProjectGithubWorkflowAddCommand.scope.join(', ')}`;
+        }
+        return true;
+    }));
+};
+SpfxProjectGithubWorkflowAddCommand.loginMethod = ['application', 'user'];
+SpfxProjectGithubWorkflowAddCommand.scope = ['tenant', 'sitecollection'];
+SpfxProjectGithubWorkflowAddCommand.ERROR_NO_PROJECT_ROOT_FOLDER = 1;
+module.exports = new SpfxProjectGithubWorkflowAddCommand();
+//# sourceMappingURL=project-github-workflow-add.js.map

package/dist/m365/spfx/commands/project/project-github-workflow-model.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=project-github-workflow-model.js.map

package/dist/m365/spfx/commands.js

@@ -6,6 +6,7 @@ exports.default = {
     PACKAGE_GENERATE: `${prefix} package generate`,
     PROJECT_DOCTOR: `${prefix} project doctor`,
     PROJECT_EXTERNALIZE: `${prefix} project externalize`,
+    PROJECT_GITHUB_WORKFLOW_ADD: `${prefix} project github workflow add`,
     PROJECT_PERMISSIONS_GRANT: `${prefix} project permissions grant`,
     PROJECT_RENAME: `${prefix} project rename`,
     PROJECT_UPGRADE: `${prefix} project upgrade`

package/dist/utils/fsUtil.js

@@ -99,6 +99,11 @@ exports.fsUtil = {
     },
     getRemoveCommand(command, shell) {
         return removeFileCommands[shell][command];
+    },
+    ensureDirectory(path) {
+        if (!fs.existsSync(path)) {
+            fs.mkdirSync(path, { recursive: true });
+        }
     }
 };
 //# sourceMappingURL=fsUtil.js.map

package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx

@@ -0,0 +1,94 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spfx project github workflow add
+
+Adds a GitHub workflow for a SharePoint Framework project
+
+## Usage
+
+```sh
+m365 spfx project github workflow add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name [name]`
+: Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
+
+`-b, --branchName [branchName]`
+: Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
+
+`-m, --manuallyTrigger`
+: When specified a manual trigger option will be added to the workflow: `workflow_dispatch`
+
+`-l, --loginMethod [loginMethod]`
+: Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`'
+
+`-s, --scope [scope]`
+: Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
+
+`-u, --siteUrl [siteUrl]`
+: The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
+
+`--skipFeatureDeployment`
+: When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
+
+`--overwrite`
+: When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
+```
+
+<Global />
+
+## Remarks
+
+The `spfx project github workflow add` will create a workflow .yml file in the `.github/workflows` directory in your project. If such directory does not exist the command will automatically create it.
+
+For the `application` login method the command does not register AAD application nor create the required certificate. In order for you to proceed you will need to first obtain (create) a self-signed certificate and register a new AAD application with certificate authentication. After that in GitHub repo settings, you will need to create the following secrets:
+
+- `APP_ID` - client id of the registered AAD application
+- `CERTIFICATE_ENCODED` - application's encoded certificate
+- `CERTIFICATE_PASSWORD` - certificate password. This applies only if the certificate is encoded which is the recommended approach
+
+This use case is perfect in a production context as it does not create any dependencies on an account
+
+For the `user` login method you will need to create the following secrets in GitHub repo settings:
+
+- `ADMIN_USERNAME` - username
+- `ADMIN_PASSWORD` - password
+
+This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
+
+:::info
+
+Run this command in the SPFx solution folder.
+
+:::
+    
+## Examples
+
+Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
+
+```sh
+m365 spfx project github workflow add 
+```
+
+Adds a GitHub workflow for a SharePoint Framework project with `user` login method triggered on push to main and when manually triggered. 
+
+```sh
+m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
+```
+
+Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
+
+```sh
+m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Automate your CI/CD workflow using CLI for Microsoft 365 GitHub Actions: [https://pnp.github.io/cli-microsoft365/user-guide/github-actions](https://pnp.github.io/cli-microsoft365/user-guide/github-actions)

package/npm-shrinkwrap.json

@@ -33,7 +33,8 @@
         "strip-json-comments": "^3.1.1",
         "typescript": "^4.9.5",
         "update-notifier": "^5.1.0",
-        "uuid": "^9.0.0"
+        "uuid": "^9.0.0",
+        "yaml": "^2.3.1"
       },
       "bin": {
         "m365": "dist/index.js",
@@ -6037,6 +6038,14 @@
       "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
       "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="
     },
+    "node_modules/yaml": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.1.tgz",
+      "integrity": "sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ==",
+      "engines": {
+        "node": ">= 14"
+      }
+    },
     "node_modules/yargs": {
       "version": "16.2.0",
       "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz",
@@ -10458,6 +10467,11 @@
       "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
       "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="
     },
+    "yaml": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.1.tgz",
+      "integrity": "sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ=="
+    },
     "yargs": {
       "version": "16.2.0",
       "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.11.0-beta.1b96aef",
+  "version": "6.11.0-beta.2d03676",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -251,7 +251,8 @@
     "strip-json-comments": "^3.1.1",
     "typescript": "^4.9.5",
     "update-notifier": "^5.1.0",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "yaml": "^2.3.1"
   },
   "devDependencies": {
     "@microsoft/microsoft-graph-types": "^2.38.0",