public-backup/astro
1
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-12-05 18:56:38 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
astro/packages/integrations/sitemap/CHANGELOG.md
Houston (Bot) 3c14936b40 [ci] release (#14342) 
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-17 10:14:22 +02:00

24 KiB
Raw Permalink Blame History

@astrojs/sitemap

3.6.0

Minor Changes

  • #14285 bedc31b Thanks @jdcolombo! - Adds a new configuration option namespaces for more control over XML namespaces used in sitemap generation

    Excluding unused namespaces can help create cleaner, more focused sitemaps that are faster for search engines to parse and use less bandwidth. If your site doesn't have news content, videos, or multiple languages, you can exclude those namespaces to reduce XML bloat.

    The namespaces option allows you to configure news, xhtml, image, and video namespaces independently. All namespaces are enabled by default for backward compatibility and no change to existing projects is necessary. But now, you can choose to streamline your XML and avoid unnecessary code.

    For example, to exclude the video namespace from your sitemap, set video: false in your configuration:

    // astro.config.mjs
import { sitemap } from '@astrojs/sitemap';

export default {
  integrations: [
    sitemap({
      namespaces: {
        video: false,
        // other namespaces remain enabled by default
      }
    })
  ]
};

    The generated XML will not include the xmlns:video namespace:

    <?xml version="1.0" encoding="UTF-8"?>
<urlset
  xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
  xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"
  xmlns:xhtml="http://www.w3.org/1999/xhtml"
  xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"
>
  <!-- ... -->
</urlset>

3.5.1

Patch Changes

  • #14233 896886c Thanks @gouravkhunger! - Fixes the issue with the option lastmod where if it is defined it applies correctly to <url> entries in each sitemap-${i}.xml file but not the <sitemap> entries in the root sitemap-index.xml file.

3.5.0

Minor Changes

  • #13682 5824b32 Thanks @gouravkhunger! - Adds a customSitemaps option to include extra sitemaps in the sitemap-index.xml file generated by Astro.

    This is useful for multi-framework setups on the same domain as your Astro site (example.com), such as a blog at example.com/blog whose sitemap is generated by another framework.

    The following example shows configuring your Astro site to include sitemaps for an externally-generated blog and help center along with the generated sitemap entries in sitemap-index.xml:

    Example:

    import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
  site: 'https://example.com',
  integrations: [
    sitemap({
      customSitemaps: [
        'https://example.com/blog/sitemap.xml',
        'https://example.com/helpcenter/sitemap.xml',
      ],
    }),
  ],
});

    Learn more in the @astrojs/sitemap configuration documentation.

3.4.2

Patch Changes

3.4.1

Patch Changes

  • #13871 8a1e849 Thanks @blimmer! - Uncaught errors in the filter method will now bubble, causing the astro build to fail.

3.4.0

Minor Changes

  • #13753 90293de Thanks @mattyoho! - Customize the filenames of sitemap XML files generated by the @astro/sitemap integration by setting filenameBase in the integration configuration settings. This may be useful when deploying an Astro site at a path on a domain with preexisting sitemap files.

    Generated sitemap files will appear at /sitemap-0.xml and /sitemap-index.xml by default, which may conflict with preexisting files. Set filenameBase to a custom value to avoid that if so:

    import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
  site: 'https://example.com',
  integrations: [
    sitemap({
      filenameBase: 'astronomy-sitemap',
    }),
  ],
});

    This will yield sitemap and index files as https://example.com/astronomy-sitemap-0.xml and https://example.com/astronomy-sitemap-index.xml.

3.3.1

Patch Changes

3.3.0

Minor Changes

3.2.1

Patch Changes

3.2.0

Minor Changes

3.1.6

Patch Changes

3.1.5

Patch Changes

  • #10779 cefeadf Thanks @adrianlyjak! - Fixes false positives for status code routes like 404 and 500 when generating sitemaps.

3.1.4

Patch Changes

3.1.3

Patch Changes

3.1.2

Patch Changes

3.1.1

Patch Changes

3.1.0

Minor Changes

  • #9846 9b78c992750cdb99c40a89a00ea2a0d1c00877d7 Thanks @ktym4a! - Adds a new configuration option prefix that allows you to change the default sitemap-*.xml file name.

    By default, running astro build creates both sitemap-index.xml and sitemap-0.xml in your output directory.

    To change the names of these files (e.g. to astrosite-index.xml and astrosite-0.xml), set the prefix option in your sitemap integration configuration:

    import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';
export default defineConfig({
  site: 'https://example.com',
  integrations: [
    sitemap({
      prefix: 'astrosite-',
    }),
  ],
});

    This option is useful when Google Search Console is unable to fetch your default sitemap files, but can read renamed files.

3.0.5

Patch Changes

3.0.4

Patch Changes

3.0.3

Patch Changes

3.0.2

Patch Changes

3.0.1

Patch Changes

3.0.0

Major Changes

  • #8188 d0679a666 Thanks @ematipico! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

  • #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

3.0.0-rc.1

Major Changes

3.0.0-beta.0

Major Changes

  • 1eae2e3f7 Thanks @Princesseuh! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

2.0.2

Patch Changes

2.0.1

Patch Changes

2.0.0

Major Changes

  • #7656 dd931a780 Thanks @natemoo-re! - Sitemap only includes page routes (generated by .astro files) rather than all routes (pages, endpoints, or redirects). This behavior matches our existing documentation, but is a breaking change nonetheless.

Patch Changes

1.4.0

Minor Changes

1.3.3

Patch Changes

1.3.2

Patch Changes

1.3.1

Patch Changes

1.3.0

Minor Changes

1.2.2

Patch Changes

1.2.1

Patch Changes

1.2.0

Minor Changes

1.1.0

Minor Changes

  • #6262 4fcefa34f Thanks @vic1707! - update ChangeFreq to support typescript configurations with string literal or predefined value.

1.0.1

Patch Changes

1.0.0

Major Changes

0.3.0

Minor Changes

  • #4015 6fd161d76 Thanks @matthewp! - New output configuration option

    This change introduces a new "output target" configuration option (output). Setting the output target lets you decide the format of your final build, either:

    • "static" (default): A static site. Your final build will be a collection of static assets (HTML, CSS, JS) that you can deploy to any static site host.
    • "server": A dynamic server application. Your final build will be an application that will run in a hosted server environment, generating HTML dynamically for different requests.

    If output is omitted from your config, the default value "static" will be used.

    When using the "server" output target, you must also include a runtime adapter via the adapter configuration. An adapter will adapt your final build to run on the deployed platform of your choice (Netlify, Vercel, Node.js, Deno, etc).

    To migrate: No action is required for most users. If you currently define an adapter, you will need to also add output: 'server' to your config file to make it explicit that you are building a server. Here is an example of what that change would look like for someone deploying to Netlify:

    import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  adapter: netlify(),
+ output: 'server',
});

Patch Changes

0.2.6

Patch Changes

0.2.5

Patch Changes

0.2.4

Patch Changes

0.2.3

Patch Changes

  • #3723 52f75369 Thanks @alextim! - fix: if serialize function returns undefined for the passed entry, such entry will be excluded from sitemap

0.2.2

Patch Changes

  • #3689 3f8ee70e Thanks @bholmesdev! - Add warning log for sitemap + SSR adapter, with suggestion to use customPages configuration option

0.2.1

Patch Changes

0.2.0

Minor Changes

  • #3579 1031c06f Thanks @alextim! - # Key features

    • Split up your large sitemap into multiple sitemaps by custom limit.
    • Ability to add sitemap specific attributes such as lastmod etc.
    • Final output customization via JS function.
    • Localization support.
    • Reliability: all config options are validated.

    Important changes

    The integration always generates at least two files instead of one:

    • sitemap-index.xml - index file;
    • sitemap-{i}.xml - actual sitemap.

0.1.2

Patch Changes

0.1.1

Patch Changes

0.1.0

Minor Changes

Patch Changes

  • e425f896 Thanks @FredKSchott! - Add new sitemap configuration options:
    • filter: filter pages to include in your sitemap
    • canonicalURL: override your astro.config site with a custom base URL

0.0.2

Patch Changes

  • #2847 3b621f7a Thanks @tony-sull! - Adds keywords to the official integrations to support discoverability on Astro's Integrations site

0.0.2-next.0

Patch Changes

  • #2847 3b621f7a Thanks @tony-sull! - Adds keywords to the official integrations to support discoverability on Astro's Integrations site