You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Microsoft Teams Deploy Card
2.1.0
A comprehensive notification card in Microsoft Teams for your deployments.
-
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 torepo
andworkflow
.MS_TEAMS_WEBHOOK_URI
- the webhook URI of the dedicated Microsoft Teams channel for notification.
-
Add this
step
on your workflow code as one of the earliersteps
:
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
- Tweak the following configurations
github-token
- (required) the value ofCI_GITHUB_TOKEN
webhook-uri
- (required) the value ofMS_TEAMS_WEBHOOK_URI
deploy-title
- (optional, defaults toGithub Actions CI
),allowed-file-len
- (optional, defaults to7
), allowed number of changed files to displaytimezone
- (optional, defaults toUTC
), a valid database timezone name, e.g. "Australia/Sydney"
- Clone this repository.
- Install JS dependencies via
yarn install
ornpm install
. - Before pushing you changes, execute
yarn ncc
to create a build ondist
. - Do not remove the
dist
repository. Ever. - Check the Actions tab for the errors if there are any.