edf-re / ms-teams-deploy-card

Microsoft Teams Deploy Card

Microsoft Teams Deploy Card

A comprehensive notification card in Microsoft Teams for your deployments.

Usage

1. Add MS_TEAMS_WEBHOOK_URI on your repository's configs on Settings > Secrets. It is the webhook URI of the dedicated Microsoft Teams channel for notification.

2. Add a new step on your workflow code below actions/checkout@v2:

name: MS Teams Deploy Card

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      # this is the new step
      - name: Notify dedicated teams channel
        uses: toko-bifrost/ms-teams-deploy-card@master #  or "./" if in a local set-up
        with:
          status: ${{ job.status }}
          github-token: ${{ github.token }}
          webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}

3. Tweak the following configurations
   • github-token - (required), this can be set to the following:
     • ${{ github.token }}
     • ${{ secrets.GITHUB_TOKEN }}
     • a manually added secret with more Github API permissions, e.g. ${{ secrets.<custom secret here> }}
   • status - (required), the status of the job to send to teams.
   • webhook-uri - (required), the value of MS_TEAMS_WEBHOOK_URI
   • deploy-title - (optional, defaults to Github Actions CI),
   • allowed-file-len - (optional, defaults to 7), allowed number of changed files to display
   • timezone - (optional, defaults to UTC), a valid database timezone name, e.g. "Australia/Sydney"

Local Set-up

1. Clone this repository.
2. Install JS dependencies via yarn install or npm install.
3. Before pushing you changes, execute yarn ncc (or npm run ncc) to create a build on dist.
4. Do not remove the dist repository. Ever.
5. Check the Actions tab for the errors if there are any.

Known Issues

• Avoid naming your secrets with the prefix GITHUB_ as secrets are being used as environment variables, and they are reserved for Github Actions' use only. Better stick with CI_GITHUB_TOKEN.
• As this is still in development, always use the working latest version from the Releases, as they have more bug fixes and added features.