This repo contains custom GitHub Actions that enable support for starting and stopping maintenance windows within our Site24x7 uptime monitoring, so that any downtime during a deployment is marked as having occurred during maintenance.

Use this action to start a maintenance window.

uses: richteambs/maintainizr-action/start
with:
    app-url: ${{ secrets.MAINTZ_FUNC_URL }}
    app-key: ${{ secrets.MAINTZ_FUNC_APP_KEY }}
    monitor-id: '12345'
    duration: 1 # 1 minute

Use this action to end a maintenance window.

If you don't call this action, the window will automatically end after the duration specified when the window was started.

If you call this action when the window is already ended, it will not report an error. This means you can safely call it even if you have overrun the maintenance window, or if you have called it multiple times.

If you pass an invalid maintenance id, the action will report an error.

uses: richteambs/maintainizr-action/end
with:
    app-url: '${{ secrets.MAINTZ_FUNC_URL }}'
    app-key: ${{ secrets.MAINTZ_FUNC_APP_KEY }}
    maintenance-id: ${{ needs.start_maintenance.outputs.maintenance-id }}

The actions in this repo work by contacting the Maintainizr API, which in turn contacts the Site24x7 API (the Maintainizr API provides a simplified facade). You therefore need to provide some parameters that specify the connection details for the Maintainizr API. These parameters are common to all the actions in this repository.

This article documents how to find out the values to use for these parameters.

Information on how you can contribute to this repo is here.

Developer documentation is here.

Rocket Icon Vectors by Vecteezy