Adds CLI_VERSION option. Closes #19

Author: michaelmaillot

.github/workflows/test_version.yml

@@ -0,0 +1,16 @@
+on: [workflow_dispatch]
+
+jobs:
+  cli_login_version_job:
+    runs-on: ubuntu-latest
+    name: CLI Login Job
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: CLI for Microsoft 365 Login
+        uses: ./
+        id: login
+        with:
+          ADMIN_USERNAME: ${{secrets.ADMIN_USERNAME}}
+          ADMIN_PASSWORD: ${{secrets.ADMIN_PASSWORD}}
+          CLI_VERSION: 5.7.0-beta.9e8cf99

README.md

@@ -19,6 +19,7 @@ Create a workflow `.yml` file in your `.github/workflows` directory. An [example
 - `CERTIFICATE_PASSWORD` : Password for the certificate
 - `APP_ID` : App ID of the Azure AD application to use for certificate authentication. If not specified, use the app specified in the 'CLIMICROSOFT365_AADAPPID' environment variable. If the environment variable is not defined, use the multitenant PnP Management Shell app
 - `TENANT` : ID of the tenant from which accounts should be able to authenticate. Use `common` or `organization` if the app is multitenant. If not specified, use the tenant specified in the `CLIMICROSOFT365_TENANT` environment variable. If the environment variable is not defined, it will use `common` as the tenant identifier
+- `CLI_VERSION` : Accepts `latest`, `next` or a specific version tag. Otherwise, installs the `latest` version when omitted
 
 All inputs are optional. But depending of the authentication type chosen, following pair of inputs will be necessary:
 
@@ -41,8 +42,8 @@ Since this action requires sensitive information such as user name, password and
 - 2 new secrets if using a custom Azure AD identity:
   - `APP_ID` - store App ID of the Azure AD application to use for authentication
   - `TENANT` - store the ID of the tenant from which accounts should be able to authenticate
-  
-These secrets are encrypted and can only be used by GitHub actions. 
+
+These secrets are encrypted and can only be used by GitHub actions.
 
 ### Example workflow - CLI for Microsoft 365 Login (user name / password authentication)
 
@@ -58,16 +59,16 @@ jobs:
     ##
     ## Build code omitted
     ##
-        
+
   deploy:
     needs: build
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [16.x]
-    
+
     steps:
-    
+
     ##
     ## Code to get the package omitted
     ##
@@ -78,7 +79,7 @@ jobs:
       with:
         ADMIN_USERNAME:  ${{ secrets.ADMIN_USERNAME }}
         ADMIN_PASSWORD:  ${{ secrets.ADMIN_PASSWORD }}
-    
+
     ##
     ## Code to deploy the package to tenant omitted
     ##
@@ -98,16 +99,16 @@ jobs:
     ##
     ## Build code omitted
     ##
-        
+
   deploy:
     needs: build
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [16.x]
-    
+
     steps:
-    
+
     ##
     ## Code to get the package omitted
     ##
@@ -120,18 +121,65 @@ jobs:
         APP_ID: ${{ secrets.APP_ID }}
         CERTIFICATE_ENCODED: ${{ secrets.CERTIFICATE_ENCODED }}
         CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
-    
+
+    ##
+    ## Code to deploy the package to tenant omitted
+    ##
+```
+
+### Example workflow - CLI for Microsoft 365 Login (beta version of the CLI)
+
+On every `push` build the code and then login to Microsoft 365 before deploying, using beta version of the CLI.
+
+```yaml
+name: SPFx CICD with Cli for Microsoft 365
+
+on: [push]
+
+jobs:
+  build:
+    ##
+    ## Build code omitted
+    ##
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+
+    ##
+    ## Code to get the package omitted
+    ##
+
+    # CLI for Microsoft 365 login action
+    - name: Login to tenant
+      uses: pnp/action-cli-login@v2.1.0
+      with:
+        TENANT: ${{ secrets.TENANT }}
+        APP_ID: ${{ secrets.APP_ID }}
+        CERTIFICATE_ENCODED: ${{ secrets.CERTIFICATE_ENCODED }}
+        CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
+        CLI_VERSION: next
+
     ##
     ## Code to deploy the package to tenant omitted
     ##
 ```
 
 #### Self-hosted runners
 
-If self-hosted runners are used for running the workflow, then please make sure that they have `PowerShell` or `bash` installed on them. 
+If self-hosted runners are used for running the workflow, then please make sure that they have `PowerShell` or `bash` installed on them.
 
 ## Release notes
 
+### v2.2.0
+
+- Adds CLI_VERSION option. Closes #19
+
 ### v2.1.0
 
 - Adds certificate login. Closes #12
@@ -142,4 +190,4 @@ If self-hosted runners are used for running the workflow, then please make sure
 
 ### v1.0.0
 
-- Added inital 'Office 365 CLI login' GitHub action solving #2
+- Added inital 'Office 365 CLI login' GitHub action solving #2

action.yml

@@ -19,6 +19,9 @@ inputs:
   TENANT:
     description: "ID of the tenant from which accounts should be able to authenticate. Use common or organization if the app is multitenant. If not specified, use the tenant specified in the 'CLIMICROSOFT365_TENANT' environment variable. If the environment variable is not defined, use 'common' as the tenant identifier"
     required: false
+  CLI_VERSION:
+    description: "When specified, installs the requested version or tag of the CLI"
+    required: false
 runs:
   using: "node16"
   main: "dist/index.js"

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/action-cli-login",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "GitHub Action to Login to a tenant using CLI for Microsoft 365",
   "license": "MIT",
   "main": "lib/main.js",

dist/index.js.map

@@ -1,5 +1,6 @@
 import * as assert from 'assert';
-import { getLoginCommand, } from './commands';
+import { getInstallCommand, getLoginCommand, } from './commands';
+import { constants } from './constants';
 import { Options } from './validate';
 
 describe('commands', () => {
@@ -13,7 +14,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: '',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             const expected = 'login --authType password --userName adminUsername --password adminPassword';
             const actual = getLoginCommand(options);
@@ -27,7 +29,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '36e3a540-6f25-4483-9542-9f5fa00bb633',
-                TENANT: '187d6ed4-5c94-40eb-87c7-d311ec5f647a'
+                TENANT: '187d6ed4-5c94-40eb-87c7-d311ec5f647a',
+                CLI_VERSION: ''
             };
             const expected = 'login --authType certificate --certificateBase64Encoded ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 --appId 36e3a540-6f25-4483-9542-9f5fa00bb633 --tenant 187d6ed4-5c94-40eb-87c7-d311ec5f647a';
             const actual = getLoginCommand(options);
@@ -41,7 +44,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
                 CERTIFICATE_PASSWORD: 'Pass@w0rd!',
                 APP_ID: '36e3a540-6f25-4483-9542-9f5fa00bb633',
-                TENANT: '187d6ed4-5c94-40eb-87c7-d311ec5f647a'
+                TENANT: '187d6ed4-5c94-40eb-87c7-d311ec5f647a',
+                CLI_VERSION: ''
             };
             const expected = 'login --authType certificate --certificateBase64Encoded ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 --password Pass@w0rd! --appId 36e3a540-6f25-4483-9542-9f5fa00bb633 --tenant 187d6ed4-5c94-40eb-87c7-d311ec5f647a';
             const actual = getLoginCommand(options);
@@ -55,7 +59,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: '',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             assert.throws(() => getLoginCommand(options), Error, 'ADMIN_USERNAME is required');
         });
@@ -67,7 +72,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: '',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             assert.throws(() => getLoginCommand(options), Error, 'ADMIN_PASSWORD is required');
         });
@@ -79,7 +85,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: '',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             assert.doesNotThrow(() => getLoginCommand(options), Error);
         });
@@ -91,7 +98,8 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: '',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             assert.throws(() => getLoginCommand(options), Error, 'CERTIFICATE_ENCODED is required if ADMIN_USERNAME and ADMIN_PASSWORD are not provided');
         });
@@ -103,10 +111,42 @@ describe('commands', () => {
                 CERTIFICATE_ENCODED: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
                 CERTIFICATE_PASSWORD: '',
                 APP_ID: '',
-                TENANT: ''
+                TENANT: '',
+                CLI_VERSION: ''
             };
             assert.doesNotThrow(() => getLoginCommand(options), Error);
         });
     });
 
+    describe('getInstallCommand', () => {
+        it('returns correct install command (latest version of the CLI)', () => {
+            const options: Options = {
+                ADMIN_USERNAME: 'adminUsername',
+                ADMIN_PASSWORD: 'adminPassword',
+                CERTIFICATE_ENCODED: '',
+                CERTIFICATE_PASSWORD: '',
+                APP_ID: '',
+                TENANT: '',
+                CLI_VERSION: ''
+            };
+            const expected = constants.CLI_NPMINSTALL_COMMAND;
+            const actual = getInstallCommand(options);
+            assert.equal(actual, expected);
+        });
+
+        it('returns correct install command (specific version of the CLI)', () => {
+            const options: Options = {
+                ADMIN_USERNAME: 'adminUsername',
+                ADMIN_PASSWORD: 'adminPassword',
+                CERTIFICATE_ENCODED: '',
+                CERTIFICATE_PASSWORD: '',
+                APP_ID: '',
+                TENANT: '',
+                CLI_VERSION: '5.4.0'
+            };
+            const expected = `${constants.CLI_NPMINSTALL_COMMAND}@${options.CLI_VERSION}`;
+            const actual = getInstallCommand(options);
+            assert.equal(actual, expected);
+        });
+    });
 });

package.json

@@ -1,3 +1,4 @@
+import { constants } from './constants';
 import { isNullOrEmpty } from './utils';
 import { Options } from './validate';
 
@@ -29,4 +30,17 @@ export function getLoginCommand(options: Options): string {
     }
 
     return authCommand;
+}
+
+export function getInstallCommand(options: Options): string {
+    let installCommand: string;
+
+    if (options.CLI_VERSION) {        
+        installCommand = `${constants.CLI_NPMINSTALL_COMMAND}@${options.CLI_VERSION}`;
+    }
+    else {
+        installCommand = constants.CLI_NPMINSTALL_COMMAND;
+    }
+
+    return installCommand;
 }

src/commands.spec.ts

@@ -7,4 +7,5 @@ export const constants = {
     ACTION_CERTIFICATE_PASSWORD: 'CERTIFICATE_PASSWORD',
     ACTION_APP_ID: 'APP_ID',
     ACTION_TENANT: 'TENANT',
+    ACTION_CLI_VERSION: 'CLI_VERSION',
 }