CLI for Microsoft 365 Runscript

GitHub action to run a script using the CLI for Microsoft 365

This GitHub Action (created using typescript) uses CLI for Microsoft 365, to run a line of script supplied to it or run code in a script file supplied to it.

Usage

Pre-requisites

Create a workflow .yml file in .github/workflows directory of your repo. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Dependencies on other GitHub Actions

• CLI for Microsoft 365 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. So, click on settings tab in your repo and add 2 new secrets:

• adminUsername - store the admin user name in this (e.g. user@contoso.onmicrosoft.com)
• adminPassword - store the password of that user in this. These secrets are encrypted and can only be used by GitHub actions.

Inputs

• CLI_MICROSOFT365_SCRIPT_PATH : Relative path of the script in your repo.
• CLI_MICROSOFT365_SCRIPT : The script to run
• IS_POWERSHELL : true|false Used only with CLI_MICROSOFT365_SCRIPT. If true the assumption is the script passed in CLI_MICROSOFT365_SCRIPT will be a PowerShell script, otherwise the assumption is bash script. Default is false

One of CLI_MICROSOFT365_SCRIPT_PATH / CLI_MICROSOFT365_SCRIPT is mandatory, in case both are defined CLI_MICROSOFT365_SCRIPT_PATH gets preference.

Example workflow - CLI for Microsoft 365 Runscript

On every push build the code, then deploy and then send an email using CLI for Microsoft 365 Runscript action.

name: SPFx CICD with CLI for Microsoft 365

on: [push]

jobs:
  
  runscript:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18.x]
    
    steps:
    
    # CLI for Microsoft 365 login action
    - name: Login to tenant
      uses: pnp/action-cli-login@v3
      with:
        ADMIN_USERNAME:  ${{ secrets.adminUsername }}
        ADMIN_PASSWORD:  ${{ secrets.adminPassword }}
    
    # CLI for Microsoft 365 runscript action option 1 (single line of script as input)
    - name: Send email
      uses: pnp/action-cli-runscript@v3
      with:
        CLI_MICROSOFT365_SCRIPT: m365 spo mail send --webUrl https://contoso.sharepoint.com/sites/teamsite --to 'user@contoso.onmicrosoft.com' --subject 'Deployment done' --body '<h2>CLI for Microsoft 365</h2> <p>The deployment is complete.</p> <br/> Email sent via CLI for Microsoft 365 GitHub Action.'
    
    # CLI for Microsoft 365 runscript action option 2 (script file as input)
    - name: Create lists
      uses: pnp/action-cli-runscript@v3
      with:
        CLI_MICROSOFT365_SCRIPT_PATH: ./script/lists.ps1 
        #lists.ps1 will have all the required CLI for Microsoft 365 commands

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.

Release notes

v3.0.0

• Bumped to Node version 20

v2.0.0

• Renames action to 'CLI for Microsoft 365 Runscript'

v1.0.0

• Added initial 'CLI for Microsoft 365 runscript' GitHub action solving #2