Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anoopt/ms-graph-create-event
:calendar: A GitHub action to create Outlook calendar event using Microsoft Graph
https://github.com/anoopt/ms-graph-create-event
actions calendar github-actions microsoft-graph
Last synced: 3 months ago
JSON representation
:calendar: A GitHub action to create Outlook calendar event using Microsoft Graph
- Host: GitHub
- URL: https://github.com/anoopt/ms-graph-create-event
- Owner: anoopt
- Created: 2019-12-02T01:06:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T10:46:36.000Z (about 2 years ago)
- Last Synced: 2024-10-05T17:47:06.845Z (3 months ago)
- Topics: actions, calendar, github-actions, microsoft-graph
- Language: JavaScript
- Homepage:
- Size: 13.2 MB
- Stars: 10
- Watchers: 5
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-actions - Create an Outlook Calendar Event using Microsoft Graph
- fucking-awesome-actions - Create an Outlook Calendar Event using Microsoft Graph
- awesome-workflows - Create an Outlook Calendar Event using Microsoft Graph
README
# GitHub Action to create event using Microsoft Graph
Creates an event in a user's calendar when an event occurs. This action can be used when say for example a pull request is created and some one has to review it. Creating an event in their calendar will prompt them a notification.
## What it does
## Pre requisites
This action uses Microsoft Graph to create an event. So please make sure that you [register an application in Azure AD](https://docs.microsoft.com/en-us/graph/auth-register-app-v2), provide that app `Calendars.ReadWrite` permissions and create a client secret for that.
In your GitHub repo [create 3 secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) with the following information:
* TENANT_NAME - The name of your Office 365 tenant (e.g. contoso.onmicrosoft.com)
* APP_ID - The Id of the app registration created above
* APP_SECRET - A secret of the app registration created above.
## Usage
Below is a workflow code
```workflow
name: MS Graph Event
on: [pull_request]
jobs:
create-event:
runs-on: ubuntu-latest
name: Create Event
steps:
- name: Create event on the next day
uses: anoopt/ms-graph-create-event@v1
env:
TENANT_NAME: ${{ secrets.TENANT_NAME }}
APP_ID: ${{ secrets.APP_ID }}
APP_SECRET: ${{ secrets.APP_SECRET }}
with:
subject: 'Review pull request'
body: 'A new PR has been submitted on ${{ github.repository }} from ${{ github.actor }}. Please review it.'
emailaddress: '[email protected]'
```
When there is a pull request, the above workflow will create an event for user '[email protected]' on the next day from 12:00 to 13:00 (automatic as no start or end is specified).
## More Information
All of the information attached to an event is available in the `github.event` variable. To see the possible values, you can use the following step in your workflow:
```yaml
- run: echo '${{ toJson(github.event) }}'
```
```workflow
name: MS Graph Event
on: [push]
jobs:
create-event:
runs-on: ubuntu-latest
name: Create Event
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Create event on the specified day and time
uses: anoopt/ms-graph-create-event@v1
env:
TENANT_NAME: ${{ secrets.TENANT_NAME }}
APP_ID: ${{ secrets.APP_ID }}
APP_SECRET: ${{ secrets.APP_SECRET }}
with:
subject: 'Code pushed'
body: 'Some files have been pushed on ${{ github.repository }} from ${{ github.actor }}. Please find the details here ${{ github.event.compare }}.'
emailaddress: '[email protected]'
start: '2019-12-04T14:30:00'
end: '2019-12-04T15:00:00'
```
When there is a code push, the above workflow will create an event for user '[email protected]' on 4th Dec 2019 from 14:30 to 15:00 with the URL of compare in details.
## Event that gets created
