Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Microsoft Teams Deploy Card

Actions
Notify your Teams channel with a beautiful, comprehensive deployment card
2.1.0
Star (98)

Microsoft Teams Deploy Card

MS Teams Deploy Card

A comprehensive notification card in Microsoft Teams for your deployments.

Usage:

  1. Add the following to your repository's configs on Settings > Secrets.

    • CI_GITHUB_TOKEN - your Personal Access Token to assume the basic authentication and other authorizations in Github API. This should at least have full permissions to repo and workflow.
    • MS_TEAMS_WEBHOOK_URI - the webhook URI of the dedicated Microsoft Teams channel for notification.
  2. Add this step on your workflow code as one of the earlier steps:

name: MS Teams Deploy Card

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Notify dedicated teams channel
        uses: toko-bifrost/ms-teams-deploy-card@master #  or "./" if in a local set-up
        with:
          github-token: ${{ secrets.CI_GITHUB_TOKEN }}
          webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}
          deploy-title: Github Actions CI
  1. Tweak the following configurations
    • github-token - (required) the value of CI_GITHUB_TOKEN
    • 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 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.

Microsoft Teams Deploy Card is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Notify your Teams channel with a beautiful, comprehensive deployment card
2.1.0

Microsoft Teams Deploy Card is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.