Due Date Changes In GitHub Projects

GitHub doesn't provide a built-in way to send notifications if a field of the project is changing. This GitHub Action aims to address this by allowing you to identify the change of the due date field within a central GitHub project.

Introduction

This GitHub Action allows you to identify changes in a central GitHub project on opened issues. If the due date field changes then
the assignees of the issue will be informed via comment.

Prerequisites

Before you can start using this GitHub Action, you'll need to ensure you have the following:

1. A GitHub repository where you want to enable this action.
2. A GitHub project board with custom "Due Date" field added.
3. "Due Date" field should be "Date" type.
4. A Token (Classic) with permissions to repo:*, read:user, user:email, read:project

Inputs

Input	Description
gh_token	The GitHub Token
project_number	The project number
due_date_field_name (optional)	The due date field name. The default is Due Date
notification_type (optional)	The notification type. Default is comment
enterprise_github (optional)	True if you are using enterprise github and false if not. Default is False
repository_owner_type (optional)	The type of the repository owner (oragnization or user). Default is user
dry_run (optional)	True if you want to enable dry-run mode. Default is False

Examples

Notify for due date change with comment

To set up due date change comment notifications, you'll need to create or update a GitHub Actions workflow in your repository. Below is an example of a workflow YAML file:

name: Notify for due date change

# Runs every minute
on:
  schedule:
    - cron: '* * * * *'
  workflow_dispatch:

jobs:
  notify_for_duedate_change:
    runs-on: self-hosted

    steps:
      # Checkout the code to be used by runner
      - name: Checkout code
        uses: actions/checkout@v3

      # Check for due date changes
      - name: Check for due date changes
        uses: emily-lambrou/[email protected]
        with:
          dry_run: ${{ vars.DRY_RUN }}           
          gh_token: ${{ secrets.GH_TOKEN }}      
          project_number: ${{ vars.PROJECT_NUMBER }} 
          enterprise_github: 'True'
          repository_owner_type: organization