Renames action to 'CLI for Microsoft 365 Deploy'

Author: garrytrinder

.DS_Store

@@ -1,17 +1,17 @@
-# Office 365 CLI deploy GitHub action
-GitHub action to deploy an app using Office 365 CLI
+# CLI for Microsoft 365 Deploy
+GitHub action to deploy an app using CLI for Microsoft 365
 
-![Office 365 CLI Deploy App](./images/cli-deploy.png)
+![CLI for Microsoft 365 Deploy App](./images/pnp-cli-microsoft365-blue.svg)
 
-This GitHub Action (created using typescript) uses [Office 365 CLI](https://pnp.github.io/office365-cli/), specifically the [spo app add](https://pnp.github.io/office365-cli/cmd/spo/app/app-add/), [spo app deploy](https://pnp.github.io/office365-cli/cmd/spo/app/app-deploy/) commands, to add and deploy.
+This GitHub Action (created using typescript) uses [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/), specifically the [spo app add](https://pnp.github.io/cli-microsoft365/cmd/spo/app/app-add/), [spo app deploy](https://pnp.github.io/cli-microsoft365/cmd/spo/app/app-deploy/) commands, to add and deploy.
 
 ## Usage
 ### Pre-requisites
-Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow---office-365-cli-deploy) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
+Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow---cli-for-microsoft-365-deploy) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
 
 ## Dependencies on other GitHub Actions
 
-- [Office 365 CLI Login](https://github.com/pnp/action-cli-login) – **Required** . This action is dependant on `action-cli-login`. So in the workflow we need to run  `action-cli-login` before using this action.
+- [CLI for Microsoft 365 Login](https://github.com/pnp/action-cli-login) – **Required** . This action is dependant on `action-cli-login`. So in the workflow we need to run  `action-cli-login` before using this action.
 
 #### Optional requirement
 Since `action-cli-login` requires user name and password which are sensitive pieces of information, it would be ideal to store them securely. We can achieve this in a GitHub repo by using [secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets). So, click on `settings` tab in your repo and add 2 new secrets:
@@ -29,11 +29,11 @@ These secrets are encrypted and can only be used by GitHub actions.
 ### Output
 - `APP_ID` : The id of the app that gets deployed
 
-### Example workflow - Office 365 CLI Deploy
+### Example workflow - CLI for Microsoft 365 Deploy
 On every `push` build the code, then login to Office 365 and then start deploying.
 
 ```yaml
-name: SPFx CICD with O365 CLI
+name: SPFx CICD with CLI for Microsoft 365
 
 on: [push]
 
@@ -56,38 +56,38 @@ jobs:
     ## Code to get the package omitted
     ##
 
-    # Office 365 cli login action
+    # CLI for Microsoft 365 login action
     - name: Login to tenant
-      uses: pnp/action-cli-login@v1.0.0
+      uses: pnp/action-cli-login@v2.0.0
       with:
         ADMIN_USERNAME:  ${{ secrets.adminUsername }}
         ADMIN_PASSWORD:  ${{ secrets.adminPassword }}
 
-    # Office 365 cli deploy app action
+    # CLI for Microsoft 365 deploy app action
     # Use either option 1 or option 2
 
     # Option 1 - Deploy app at tenant level
     - name: Option 1 - Deploy app to tenant
       id: o365clideploy # optional - use if output needs to be used
-      uses: pnp/action-cli-deploy@v1.0.1
+      uses: pnp/action-cli-deploy@v2.0.0
       with:
-        APP_FILE_PATH: sharepoint/solution/spfx-o365-cli-action.sppkg
+        APP_FILE_PATH: sharepoint/solution/spfx-cli-microsoft365-action.sppkg
         SKIP_FEATURE_DEPLOYMENT: true
         OVERWRITE: true
     # Option 1 - ends
 
     # Option 2 - Deploy app to a site collection
     - name: Option 2 - Deploy app to a site collection
-      uses: pnp/action-cli-deploy@v1.0.1
+      uses: pnp/action-cli-deploy@v2.0.0
       with:
-        APP_FILE_PATH: sharepoint/solution/spfx-o365-cli-action.sppkg
+        APP_FILE_PATH: sharepoint/solution/spfx-cli-microsoft365-action.sppkg
         SCOPE: sitecollection
         SITE_COLLECTION_URL: https://contoso.sharepoint.com/sites/teamsite
     # Option 2 - ends
 
     # Print the id of the app
     - name: Get the id of the app deployed
-      run: echo "The id of the app deployed is ${{ steps.o365clideploy.outputs.APP_ID }}"
+      run: echo "The id of the app deployed is ${{ steps.climicrosoft365deploy.outputs.APP_ID }}"
 ```
 
 
@@ -96,8 +96,13 @@ If self-hosted runners are used for running the workflow, then please make sure
 
 ## Release notes
 
-### v1.0.0
-- Added inital 'Office 365 CLI deploy' GitHub action solving #2
+### v2.0.0
+
+- Renames action to 'CLI for Microsoft 365' 
 
 ### v1.0.1
-- Fixed 'skipFeatureDeployment not included in spo app deploy command for Windows' solving #4
+- Fixed 'skipFeatureDeployment not included in spo app deploy command for Windows' solving #4
+
+### v1.0.0
+- Added inital 'CLI for Microsoft 365 deploy' GitHub action solving #2
+

README.md

@@ -1,5 +1,5 @@
-name: 'Office 365 CLI Deploy App'
-description: 'Deploy an app using Office 365 CLI'
+name: 'CLI for Microsoft 365 Deploy App'
+description: 'Deploy an app using CLI for Microsoft 365'
 inputs:
   APP_FILE_PATH:  
     description: 'Relative path of the app in your repo'

action.yml

@@ -974,11 +974,11 @@ const core = __importStar(__webpack_require__(470));
 const exec_1 = __webpack_require__(986);
 const io_1 = __webpack_require__(1);
 const fs_1 = __webpack_require__(747);
-let o365CLIPath;
+let cliMicrosoft365Path;
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            o365CLIPath = yield io_1.which("o365", true);
+            cliMicrosoft365Path = yield io_1.which("m365", true);
             const appFilePath = core.getInput("APP_FILE_PATH", { required: true });
             const scope = core.getInput("SCOPE", { required: false });
             const siteCollectionUrl = core.getInput("SITE_COLLECTION_URL", { required: false });
@@ -993,13 +993,13 @@ function main() {
                         core.setFailed("SITE_COLLECTION_URL not specified");
                     }
                     else {
-                        appId = yield executeO365CLICommand(`spo app add -p ${appFilePath} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${overwrite}`, true);
-                        yield executeO365CLICommand(`spo app deploy --id ${appId} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${skipFeatureDeployment}`);
+                        appId = yield executeCLIMicrosoft365Command(`spo app add -p ${appFilePath} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${overwrite}`, true);
+                        yield executeCLIMicrosoft365Command(`spo app deploy --id ${appId} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${skipFeatureDeployment}`);
                     }
                 }
                 else {
-                    appId = yield executeO365CLICommand(`spo app add -p ${appFilePath} ${overwrite}`, true);
-                    yield executeO365CLICommand(`spo app deploy --id ${appId} ${skipFeatureDeployment}`);
+                    appId = yield executeCLIMicrosoft365Command(`spo app add -p ${appFilePath} ${overwrite}`, true);
+                    yield executeCLIMicrosoft365Command(`spo app deploy --id ${appId} ${skipFeatureDeployment}`);
                 }
                 core.info("✅ Upload and deployment complete.");
                 core.setOutput("APP_ID", appId);
@@ -1015,18 +1015,18 @@ function main() {
         }
     });
 }
-function executeO365CLICommand(command, cleanOutput) {
+function executeCLIMicrosoft365Command(command, cleanOutput) {
     return __awaiter(this, void 0, void 0, function* () {
-        let o365CLICommandOutput = '';
+        let cliMicrosoft365CommandOutput = '';
         const options = {};
         options.listeners = {
             stdout: (data) => {
-                o365CLICommandOutput += data.toString();
+                cliMicrosoft365CommandOutput += data.toString();
             }
         };
         try {
-            yield exec_1.exec(`"${o365CLIPath}" ${command}`, [], options);
-            return cleanOutput ? o365CLICommandOutput.trim() : o365CLICommandOutput;
+            yield exec_1.exec(`"${cliMicrosoft365Path}" ${command}`, [], options);
+            return cleanOutput ? cliMicrosoft365CommandOutput.trim() : cliMicrosoft365CommandOutput;
         }
         catch (err) {
             throw new Error(err);

dist/index.js

@@ -1,11 +1,10 @@
 {
   "name": "@pnp/action-cli-deploy",
-  "version": "1.0.1",
-  "description": "GitHub Action to deploy an app using Office 365 CLI",
+  "version": "2.0.0",
+  "description": "GitHub Action to deploy an app using CLI for Microsoft 365",
   "main": "dist/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "ncc build src\\main.ts"
+    "build": "ncc build src/main.ts"
   },
   "author": "Tatti, Anoop <[email protected]>",
   "maintainers": [
@@ -23,6 +22,16 @@
       "name": "Garry Trinder",
       "email": "[email protected]",
       "web": "https://garrytrinder.github.io/"
+    },
+    {
+      "name": "Albert-Jan Schot",
+      "email": "[email protected]",
+      "web": "https://www.cloudappie.nl/"
+    },
+    {
+      "name": "Rabia Williams",
+      "email": "[email protected]",
+      "web": "https://rabiawilliams.com/"
     }
   ],
   "contributors": [
@@ -41,10 +50,11 @@
     "url": "https://github.com/pnp/action-cli-deploy/issues"
   },
   "keywords": [
-    "GitHub action",
     "office 365",
+    "microsoft 365",
     "sharepoint framework",
     "o365",
+    "m365",
     "spfx",
     "sharepoint online",
     "sharepoint",
@@ -67,4 +77,4 @@
     "typescript": "^3.7.4",
     "@types/node": "^13.1.6"
   }
-}
+}

images/cli-deploy.png

@@ -3,11 +3,11 @@ import { exec } from '@actions/exec';
 import { which } from '@actions/io';
 import { existsSync } from 'fs';
 
-let o365CLIPath: string;
+let cliMicrosoft365Path: string;
 
 async function main() {
     try {
-        o365CLIPath = await which("o365", true);
+        cliMicrosoft365Path = await which("m365", true);
 
         const appFilePath: string = core.getInput("APP_FILE_PATH", { required: true });
         const scope: string = core.getInput("SCOPE", { required: false });
@@ -24,12 +24,12 @@ async function main() {
                     core.error("🚨 Site collection URL - SITE_COLLECTION_URL - is needed when scope is set to sitecollection.");
                     core.setFailed("SITE_COLLECTION_URL not specified");
                 } else {
-                    appId = await executeO365CLICommand(`spo app add -p ${appFilePath} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${overwrite}`, true);
-                    await executeO365CLICommand(`spo app deploy --id ${appId} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${skipFeatureDeployment}`);
+                    appId = await executeCLIMicrosoft365Command(`spo app add -p ${appFilePath} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${overwrite}`, true);
+                    await executeCLIMicrosoft365Command(`spo app deploy --id ${appId} --scope sitecollection --appCatalogUrl ${siteCollectionUrl} ${skipFeatureDeployment}`);
                 }
             } else {
-                appId = await executeO365CLICommand(`spo app add -p ${appFilePath} ${overwrite}`, true);
-                await executeO365CLICommand(`spo app deploy --id ${appId} ${skipFeatureDeployment}`);
+                appId = await executeCLIMicrosoft365Command(`spo app add -p ${appFilePath} ${overwrite}`, true);
+                await executeCLIMicrosoft365Command(`spo app deploy --id ${appId} ${skipFeatureDeployment}`);
             }
             core.info("✅ Upload and deployment complete.");
             core.setOutput("APP_ID", appId);
@@ -43,17 +43,17 @@ async function main() {
     }
 }
 
-async function executeO365CLICommand(command: string, cleanOutput?: boolean): Promise<any> {
-    let o365CLICommandOutput = '';
+async function executeCLIMicrosoft365Command(command: string, cleanOutput?: boolean): Promise<any> {
+    let cliMicrosoft365CommandOutput = '';
     const options: any = {};
     options.listeners = {
         stdout: (data: Buffer) => {
-            o365CLICommandOutput += data.toString();
+            cliMicrosoft365CommandOutput += data.toString();
         }
     };
     try {
-        await exec(`"${o365CLIPath}" ${command}`, [], options);
-        return cleanOutput ? o365CLICommandOutput.trim() : o365CLICommandOutput;
+        await exec(`"${cliMicrosoft365Path}" ${command}`, [], options);
+        return cleanOutput ? cliMicrosoft365CommandOutput.trim() : cliMicrosoft365CommandOutput;
     }
     catch (err) {
         throw new Error(err);