Renames action to 'CLI for Microsoft 365 Login'

Author: garrytrinder

README.md

@@ -1,13 +1,13 @@
-# Office 365 CLI login GitHub action
-GitHub action to login to a tenant using Office 365 CLI.
+# CLI for Microsoft 365 Login
+GitHub action to login to a tenant using CLI for Microsoft 365.
 
-![Office 365 CLI Login](./images/cli-login.png)
+![CLI for Microsoft 365](./images/pnp-cli-microsoft365-blue.svg)
 
-This GitHub Action (created using typescript) uses [Office 365 CLI](https://pnp.github.io/office365-cli/), specifically the [login command](https://pnp.github.io/office365-cli/cmd/login), to allow you log in to Office 365.
+This GitHub Action (created using typescript) uses [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/), specifically the [login command](https://pnp.github.io/cli-microsoft365/cmd/login), to allow you log in to Microsoft 365.
 
 ## Usage
 ### Pre-requisites
-Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow---office-365-cli-login) 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-login) 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).
 
 ### Inputs
 - `ADMIN_USERNAME` : **Required** Username (email address of the admin)
@@ -19,11 +19,11 @@ Since this action requires user name and password which are sensitive pieces of
 - `adminPassword` - store the password of that user in this.
 These secrets are encrypted and can only be used by GitHub actions. 
 
-### Example workflow - Office 365 CLI Login
+### Example workflow - CLI for Microsoft 365 Login
 On every `push` build the code and then login to Office 365 before deploying.
 
 ```yaml
-name: SPFx CICD with O365 CLI
+name: SPFx CICD with Cli for Microsoft 365
 
 on: [push]
 
@@ -46,9 +46,9 @@ 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 }}
@@ -63,5 +63,8 @@ If self-hosted runners are used for running the workflow, then please make sure
 
 ## Release notes
 
+### v2.0.0
+- Renames action to 'CLI for Microsoft 365'
+
 ### v1.0.0
 - Added inital 'Office 365 CLI login' GitHub action solving #2

action.yml

@@ -1,5 +1,5 @@
-name: 'Office 365 CLI Login'
-description: 'Login to tenant using Office 365 CLI'
+name: 'CLI for Microsoft 365 Login'
+description: 'Login to tenant using CLI for Microsoft 365'
 inputs:
   ADMIN_USERNAME:  
     description: 'Username (email address) of the admin'

dist/index.js

@@ -973,27 +973,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
 const exec_1 = __webpack_require__(986);
 const io_1 = __webpack_require__(1);
-let o365CLIPath;
+let cliMicrosoft365Path;
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const username = core.getInput("ADMIN_USERNAME", { required: true });
             const password = core.getInput("ADMIN_PASSWORD", { required: true });
-            core.info("ℹ️ Installing Office 365 CLI...");
-            const o365CLIInstallCommand = "npm install -g @pnp/office365-cli";
+            core.info("ℹ️ Installing CLI for Microsoft 365...");
+            const cliMicrosoft365InstallCommand = "npm install -g @pnp/cli-microsoft365";
             const options = {};
             options.silent = true;
             if (process.env.RUNNER_OS == "Windows") {
-                yield exec_1.exec(o365CLIInstallCommand, [], options);
+                yield exec_1.exec(cliMicrosoft365InstallCommand, [], options);
             }
             else {
-                yield exec_1.exec(`sudo ${o365CLIInstallCommand}`, [], options);
+                yield exec_1.exec(`sudo ${cliMicrosoft365InstallCommand}`, [], options);
             }
-            o365CLIPath = yield io_1.which("o365", true);
-            core.info("✅ Completed installing Office 365 CLI.");
+            cliMicrosoft365Path = yield io_1.which("m365", true);
+            core.info("✅ Completed installing CLI for Microsoft 365.");
             core.info("ℹ️ Logging in to the tenant...");
-            yield executeO365CLICommand(`login --authType password --userName ${username} --password ${password}`);
-            yield executeO365CLICommand("status");
+            yield executeCLIMicrosoft365Command(`login --authType password --userName ${username} --password ${password}`);
+            yield executeCLIMicrosoft365Command("status");
             core.info("✅ Login successful.");
         }
         catch (err) {
@@ -1002,10 +1002,10 @@ function main() {
         }
     });
 }
-function executeO365CLICommand(command) {
+function executeCLIMicrosoft365Command(command) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            yield exec_1.exec(`"${o365CLIPath}" ${command}`, [], {});
+            yield exec_1.exec(`"${cliMicrosoft365Path}" ${command}`, [], {});
         }
         catch (err) {
             throw new Error(err);

images/cli-login.png

@@ -1,11 +1,10 @@
 {
   "name": "@pnp/action-cli-login",
-  "version": "1.0.0",
-  "description": "GitHub Action to Login to a tenant using Office 365 CLI",
+  "version": "2.0.0",
+  "description": "GitHub Action to Login to a tenant 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 <anoop@live.co.uk>",
   "maintainers": [
@@ -23,6 +22,16 @@
       "name": "Garry Trinder",
       "email": "garry.trinder@live.com",
       "web": "https://garrytrinder.github.io/"
+    },
+    {
+      "name": "Albert-Jan Schot",
+      "email": "appie@digiwijs.nl",
+      "web": "https://www.cloudappie.nl/"
+    },
+    {
+      "name": "Rabia Williams",
+      "email": "rabiawilliams@gmail.com",
+      "web": "https://rabiawilliams.com/"
     }
   ],
   "contributors": [
@@ -41,10 +50,11 @@
     "url": "https://github.com/pnp/action-cli-login/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/pnp-cli-microsoft365-blue.svg

@@ -2,31 +2,31 @@ import * as core from '@actions/core';
 import { exec } from '@actions/exec';
 import { which } from '@actions/io';
 
-let o365CLIPath: string;
+let cliMicrosoft365Path: string;
 
 async function main() {
     try {
         const username: string = core.getInput("ADMIN_USERNAME", { required: true });
         const password: string = core.getInput("ADMIN_PASSWORD", { required: true });
 
-        core.info("ℹ️ Installing Office 365 CLI...");
+        core.info("ℹ️ Installing CLI for Microsoft 365...");
 
-        const o365CLIInstallCommand: string = "npm install -g @pnp/office365-cli";
+        const cliMicrosoft365InstallCommand: string = "npm install -g @pnp/cli-microsoft365";
         const options: any = {};
         options.silent = true;
         if (process.env.RUNNER_OS == "Windows") {
-            await exec(o365CLIInstallCommand, [], options);
+            await exec(cliMicrosoft365InstallCommand, [], options);
         } else {
-            await exec(`sudo ${o365CLIInstallCommand}`, [], options);
+            await exec(`sudo ${cliMicrosoft365InstallCommand}`, [], options);
         }
-        o365CLIPath = await which("o365", true);
+        cliMicrosoft365Path = await which("m365", true);
 
-        core.info("✅ Completed installing Office 365 CLI.");
+        core.info("✅ Completed installing CLI for Microsoft 365.");
 
         core.info("ℹ️ Logging in to the tenant...");
 
-        await executeO365CLICommand(`login --authType password --userName ${username} --password ${password}`);
-        await executeO365CLICommand("status");
+        await executeCLIMicrosoft365Command(`login --authType password --userName ${username} --password ${password}`);
+        await executeCLIMicrosoft365Command("status");
 
         core.info("✅ Login successful.");
 
@@ -36,9 +36,9 @@ async function main() {
     }
 }
 
-async function executeO365CLICommand(command: string) {
+async function executeCLIMicrosoft365Command(command: string) {
     try {
-        await exec(`"${o365CLIPath}" ${command}`, [], {});
+        await exec(`"${cliMicrosoft365Path}" ${command}`, [], {});
     }
     catch (err) {
         throw new Error(err);