- Resolve deprecation warning on using Kernel#open in Ruby 2.7 (use URI.open instead) #342
- Support S3 Endpoints for S3 Compliant Providers like DigitalOcean Spaces #325
- Resolve
BigDecimal.new is deprecated
warnings in Ruby 2.5 #305. - Resolve
instance variable not initialized
,File.exists? is deprecated
and'*' interpreted as argument prefix
warnings #304.
- Use
yaml_tag
instead ofyaml_as
, which was deprecated in Ruby 2.4, and removed in 2.5 #298.
Backwards incompatible changes
- Adapters (AWS SDK, S3, Fog & Wave) no longer load their dependencies. It is up to the user
to
require
the appropriate libraries for the adapter to work. - AwsSdkAdapter: Fixed #279 where sitemaps were incorrectly nested under a
sitemaps/
directory in S3 - Stop supporting Ruby < 2.0, test with Ruby 2.4.
Other changes
- If Rails is defined but the application is not loaded, don't include the URL helpers.
- Ensure files have 644 permissions when building to try to address issue #264
- Use HTTPS in the Gemfile (PR ##263)
- Add
max_sitemap_links
option support for limiting how many links each sitemap can hold. Issue #188 PR #262 - Upgrade development dependencies
- Modernize Gemfile & gemspec
- Bring specs up to RSpec 3.5
- Remove Geo sitemap support. Google no longer supports them. Issue #246
- Use
sitemap
namespace for Capistrano tasks (rather thandeploy
). PR #241 - Use presence of
Rails::VERSION
to detect when running under Rails, rather than justRails
constant. PR #221 - Remove gem post-install message warning about incompatible changes in version 4
- New
SitemapGenerator::AwsSdkAdapter
adapter using the bare aws-sdk gem. - Fix Bing ping url.
- Support string option keys passed to
add
. - In Railtie, Load the rake task instead of requiring them.
- Require only
fog-aws
instead offog
for theS3Adapter
and support using IAM profile instead of setting access key & secret directly. - Implement
respond_to?
on theSitemapGenerator::Sitemap
pseudo class. - Make
:lang
optional on alternate links so they can be used for AppIndexing. - Documented Mobile Sitemaps
:mobile
option.
- Use MIT licence.
- Fix deploys with Capistrano 3 (#163).
- Allow any Fog storage options for S3 adapter (#167).
- Don't include the
media
attribute on alternate links unless it's given
- Add support for Video sitemaps options
:live
and ':requires_subscription'
- Set maximum filesize to 10,000,000 bytes rather than 10,485,760 bytes.
- Include new
SitemapGenerator::FogAdapter
(#138). - Fix usage of attr_* methods in
LinkSet
- Don't override custom getters/setters (#144).
- Fix breaking spec in Ruby 2 (#142).
- Include Capistrano 3.x tasks (#141).
- Support new
:compress
option for customizing which files get compressed. - Remove old deprecated methods:
- Removed options to
LinkSet::add()
::sitemaps_namer
and:sitemap_index_namer
(use:namer
option) - Removed
LinkSet::sitemaps_namer=
,LinkSet::sitemaps_namer
(useLinkSet::namer=
andLinkSet::namer
) - Removed
LinkSet::sitemaps_index_namer=
,LinkSet::sitemaps_index_namer
(useLinkSet::namer=
andLinkSet::namer
) - Removed the
SitemapGenerator::SitemapNamer
class (useSitemapGenerator::SimpleNamer
) - Removed
LinkSet::add_links()
(useLinkSet::create()
)
- Removed options to
- Support
fog_path_style
option in theSitemapGenerator::S3Adapter
so buckets with dots in the name work over HTTPS without SSL certificate problems.
- Support integer timestamps.
- Update README for new features added in last release.
- Support
media
attibute on alternate links (#125). - Changed
SitemapGenerator::S3Adapter
to write files in a single operation, avoiding potential permissions errors when listing a directory prior to writing (#130). - Remove Sitemap Writer from ping task (#129).
- Support
url:expires
element (#126).
- Update Google ping URL.
- Quote the ping URL in the output.
- Support Video
video:price
element (#117). - Support symbols as well as strings for most arguments to
add()
(#113). - Ensure that
public_path
andsitemaps_path
end with a slash (/
) (#113).
- Support setting the S3 region.
- Fixed bug where incorrect URL was being used in the ping to search engines - only affected sites with a single sitemap file and no index file.
- Output the URL being pinged in the verbose output.
- Test in Rails 4.
- PageMap sitemap support.
- Tested with Rails 4 pre-release.
- Add a post install message regarding the naming convention change.
- NEW, NON-BACKWARDS COMPATIBLE CHANGES.
create_index
defaults to:auto
.- Define
SitemapGenerator::SimpleNamer
class for simpler custom namers compatible with the new naming conventions. - Deprecate
sitemaps_namer
,sitemap_index_namer
and their respective namer classes. - Support
nofollow
option on alternate links. - Fix formatting of
publication_date
in News sitemaps.
- Support alternate links for urls
- Support configurable options in the
SitemapGenerator::S3Adapter
- Support creating sitemaps with no index file
- Fix syntax error in
SitemapGenerator::S3Adapter
- Support mobile tags
- Add
SitemapGenerator::S3Adapter
, a simple S3 adapter which uses Fog and doesn't require CarrierWave - Remove Ask from the sitemap ping because the service has been shutdown
- Turn off
include_index
by default - Fix the news XML namespace
- Only include
autoplay
attribute if present
- Bugfix
- Groups inherit current adapter
- Add
add_to_index
method to add links to the sitemap index. - Add
sitemap
method for accessing theLinkSet instance from within
create()`. - Don't modify options hashes passed to methods. Fix and improve
yield_sitemap
option handling.
- Framework agnostic!
- Fix alignment in output
- Show directory sitemaps are being generated into
- Only show sitemap compressed file size
- Toggle output using VERBOSE environment variable
- Remove tasks/ directory because it's deprecated in Rails 2
- Simplify dependencies.
- Support adding new search engines to ping and modifying the default search engines.
- Allow the URL of the sitemap index to be passed as an argument to
ping_search_engines
. See Pinging Search Engines in README.
- Extend and improve Video Sitemap support.
- Include sitemap docs in the README, support all element attributes, properly format values.
- Improve format of float priorities
- Remove Yahoo from ping - the Yahoo service has been shut down.
- Fix the
lastmod
value on sitemap file links
- Fix verbose setting in the rake task, it should default to true
- Allow special characters in URLs (don't use
URI.join
to construct URLs)
- Fix calling
create
with bothfilename
andsitemaps_namer
options
- Support multiple videos per url using the new
videos
option toadd()
.
- Support calling
create()
multiple times in a sitemap config - Support host names with path segments so you can use a
default_host
like'http://mysite.com/subdirectory/'
- Turn off
include_index
when thesitemaps_host
differs fromdefault_host
- Add docs about how to upload to remote hosts.
- News sitemap support
- Fix uploading to the (bucket) root on a remote server
- Support read-only filesystems like Heroku by supporting uploading to remote host
- Minor improvements to verbose handlig
- Prevent missing
Timeout
issue
- Introducing a new simpler API, Sitemap Groups, Sitemap Namers and more!
- New options
include_root
,include_index
- Major testing & refactoring
- Geo sitemap support
- Multiple sitemap support via CONFIG_FILE rake option
- Support setting the sitemaps path
- Verified working with Rails 3 stable release
- Video sitemap support
- Image Sitemap support
- Rails 3 prerelease support (beta)