Automate Sitemap and URL Submission to IndexNow 🔎#

Why Use IndexNow?#

Are you concerned about search engine optimization (SEO)? Do you want to make sure your website is indexed frequently by Bing, Yandex, DuckDuckGo, and other search engines?

Imagine submitting all your sitemap URLs to IndexNow when your website is updated, so that search engines know when to crawl your site again. This is what this action does.

How to Automatically Submit Sitemap and URLs to IndexNow#

This workflow for GitHub Actions will automatically submit your sitemap to IndexNow for faster indexing by Bing, Yandex, DuckDuckGo and other search engines.

If you're already using GitHub Actions, simply add this action to your workflow. It can automatically submit your sitemap to IndexNow whenever you deploy changes to your site or at a specific time.

How to Use#

Example workflow that you can adjust to your needs:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

name: Submit Sitemap URLs to IndexNow

on:
  schedule:
    - cron: 0 0 1 * *  # Run at midnight UTC on the 1st day of each month.

jobs:
  submit-sitemap:
    runs-on: ubuntu-latest
    steps:
      - name: Submit sitemap URLs to IndexNow
        uses: jakob-bagterp/index-now-submit-sitemap-urls-action@v1
        with:
          host: example.com
          api_key: ${{ secrets.INDEX_NOW_API_KEY }}
          api_key_location: https://example.com/${{ secrets.INDEX_NOW_API_KEY }}.txt
          endpoint: yandex
          sitemap_locations: https://example.com/sitemap.xml

Learn more in the user guide and find more parameters to customise the workflow.

Workflow Triggers#

If you're using GitHub Pages to deploy your website, you can also use this action to automatically submit the URLs of your sitemap to IndexNow. Simply adjust the on trigger so that it runs after your website has been successfully deployed:

3
4
5
6

on:
  workflow_run:
    workflows: [pages-build-deployment]
    types: [completed]

There are many more workflow trigger variations to cover your needs.

Next Steps#

Ready to try? Let's get started.

Or find more information on GitHub Marketplace:

View on GitHub Marketplace

Support the Project#

If you have already downloaded and tried the package – maybe even used it in a production environment – perhaps you would like to support its development?