Build Status

This library and rake task enables you to easily inform search engines when you update your sitemap.xml.


Add this line to your application's Gemfile:

gem 'sitemap-ping'

And then execute:

$ bundle


The easiest (manual) method is to invoke this gem via your project's Rakefile.

Default task configuration

Add the sitemap:ping task with a default configuration suitable for a Jekyll site:

require 'sitemap/ping_task'

This task will (a) read your Jekyll site configuration and (b) assume you're using the jekyll-sitemap plugin. For example, given this site configuration in _config.yml:

baseurl: ''

PingTask will assume your sitemap is located at

Customizing the task configuration

PingTask accepts a custom task name via constructor argument. Additional configuration can be specified by passing a block:

require 'sitemap/ping_task' do |pt|
  pt.description = 'My custom task description'
  pt.engines = [:google] # Valid options are :google and/or :bing
  pt.sitemap_url = '' # Override auto-detection from _config.yml


After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at


The gem is available as open source under the terms of the MIT License.