Skip to content

This GitHub action will help you to schedule a ping to a specified URL at certain intervals.

License

Notifications You must be signed in to change notification settings

sisodiya2421/pinger

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scheduled Ping

This action pings your specified URL every 30 minutes(changeable) and generates timing details using cURL.

Secrets

URL (Required) The URL to ping must be specified under secrets settings in your repository for this action to work on that URL.

You can go to this Link to get details about adding secrets to your repository

Example usage

Copy the following workflow example code into a .github/workflows/main.yml

Note You may rename main.yml as per your own requirements.

name: Scheduled Ping
# This workflow is triggered at a scheduled interval of every 30 minutes
on:
  schedule:
    # * is a special character in YAML so you have to quote this string.
    # /30 denotes that it will run once every 30 minutes
    - cron:  '*/30 * * * *'

jobs:
  pinger_job:
    name: A job to ping
    runs-on: ubuntu-latest
    env:
      URL: ${{ secrets.URL }}
      METHOD: GET  # the method used to make the request. It is GET by default
    steps:
      - id: ping
        uses: sisodiya2421/pinger@master

NOTE You can change the time interval according to your own need. Default is 30 minutes. All you need to do is just replace '*/30 * * * *' in line - cron: '*/30 * * * *' with your suitable timing. Remember the shortest interval you can run scheduled workflows is once every 5 minutes.

Some patterns for help

// Every Monday at 1PM UTC (9AM EST)
0 13 * * 1

// At the end of every day
0 0 * * *

// Every 10 minutes
*/10 * * *

You can also take a look at crontab.guru to construct a cron.

For more information about cron syntax, see "Events that trigger workflows".