koconder / no-out-of-hours-merge

Github action to block out of business hours merges

⏰ No Out of Hours Merge (Github Action)

A GitHub Action that prevents merging pull requests outside of specified business hours or on weekends. This action can be configured with custom time zones, restricted times, and custom messages.

Features

• Customizable time zone and restricted hours
• Optional custom message for pull request comments
• Allows hotfixes to bypass the time restrictions
• Provides informative error messages and input validation
• Allows for rules on specific days
• Support for holidays (thanks to holidays pip package)

Requirements

• Python 3.9 or higher
• PyGithub
• pytz
• holidays

Usage

To use the No Out of Hours Merge GitHub Action, add the following workflow to your GitHub repository:

name: No Out of Hours Merge

on:
  pull_request:
    types:
      - opened
      - synchronize
      - reopened

jobs:
  no_weekend_merge:
    name: Out of Hours Check ⏰
    runs-on: ubuntu-latest
    timeout-minutes: 2
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.9

      - name: Block merge during specified times
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TIMEZONE: "Australia/Sydney"
          RESTRICTED_TIMES: >
            {
              "weekly": [
                {
                  "days": ["mon", "tue", "wed", "thu", "fri"],
                  "intervals": [[0, 7], [16.5, 24]]
                }
              ],
              "dates": [
                {
                  "date": "2023-12-25",
                  "intervals": [[0, 24]]
                }
              ],
              "holidays": {
                "country": "GB",
                "state": "UK",
                "intervals": [[0, 24]]
              }
            }
          CUSTOM_MESSAGE: "⚠️ **PR merging is not allowed outside business hours. Let's not be a cowboy!** ⚠️"
        run: no-weekend-merge

Configuration

You can configure the action using the following environment variables:

• GITHUB_TOKEN: Required to post a message back to the PR.
• CUSTOM_MESSAGE: The custom message that will be posted as a comment on the pull request if merging is not allowed (default: "⚠️ PR merging is not allowed outside business hours. ⚠️").
• CHECK_EXISTING_COMMENT: Dont post the same message twice (default: enabled)
• TIMEZONE: The timezone used for checking the current time (default: "Australia/Sydney").
• RESTRICTED_TIMES: A JSON string containing the restricted times for each day of the week (default: the provided example in the Usage section).

License

This project is licensed under the GNU General Public License v3.0.