Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ci] release #2861

Merged
merged 3 commits into from
Feb 15, 2025
Merged

[ci] release #2861

merged 3 commits into from
Feb 15, 2025

Conversation

astrobot-houston
Copy link
Collaborator

@astrobot-houston astrobot-houston commented Feb 5, 2025

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@astrojs/starlight-docsearch@0.6.0

Minor Changes

  • #2578 f895f75 and #2390 f493361 Thanks @HiDeoo and @delucis!
    ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.32.0

    Please use the @astrojs/upgrade command to upgrade your project:

    npx @astrojs/upgrade

@astrojs/starlight@0.32.0

Minor Changes

  • #2390 f493361 Thanks @delucis! - Moves route data to Astro.locals instead of passing it down via component props

    ⚠️ BREAKING CHANGE:
    Previously, all of Starlight’s templating components, including user or plugin overrides, had access to a data object for the current route via Astro.props.
    This data is now available as Astro.locals.starlightRoute instead.

    To update, refactor any component overrides you have:

    • Remove imports of @astrojs/starlight/props, which is now deprecated.
    • Update code that accesses Astro.props to use Astro.locals.starlightRoute instead.
    • Remove any spreading of {...Astro.props} into child components, which is no longer required.

    In the following example, a custom override for Starlight’s LastUpdated component is updated for the new style:

    ---
    import Default from '@astrojs/starlight/components/LastUpdated.astro';
    - import type { Props } from '@astrojs/starlight/props';
    
    - const { lastUpdated } = Astro.props;
    + const { lastUpdated } = Astro.locals.starlightRoute;
    
    const updatedThisYear = lastUpdated?.getFullYear() === new Date().getFullYear();
    ---
    
    {updatedThisYear && (
    -   <Default {...Astro.props}><slot /></Default>
    +   <Default><slot /></Default>
    )}

    Community Starlight plugins may also need to be manually updated to work with Starlight 0.32. If you encounter any issues, please reach out to the plugin author to see if it is a known issue or if an updated version is being worked on.

  • #2578 f895f75 Thanks @HiDeoo! - Deprecates the Starlight plugin setup hook in favor of the new config:setup hook which provides the same functionality.

    ⚠️ BREAKING CHANGE:

    The Starlight plugin setup hook is now deprecated and will be removed in a future release. Please update your plugins to use the new config:setup hook instead.

    export default {
      name: 'plugin-with-translations',
      hooks: {
    -   'setup'({ config }) {
    +   'config:setup'({ config }) {
          // Your plugin configuration setup code
        },
      },
    };
  • #2578 f895f75 Thanks @HiDeoo! - Exposes the built-in localization system in the Starlight plugin config:setup hook.

    ⚠️ BREAKING CHANGE:

    This addition changes how Starlight plugins add or update translation strings used in Starlight’s localization APIs.
    Plugins previously using the injectTranslations() callback function from the plugin config:setup hook should now use the same function available in the i18n:setup hook.

    export default {
      name: 'plugin-with-translations',
      hooks: {
    -   'config:setup'({ injectTranslations }) {
    +   'i18n:setup'({ injectTranslations }) {
          injectTranslations({
            en: {
              'myPlugin.doThing': 'Do the thing',
            },
            fr: {
              'myPlugin.doThing': 'Faire le truc',
            },
          });
        },
      },
    };
  • #2858 2df9d05 Thanks @XREvo! - Adds support for Pagefind’s multisite search features

  • #2578 f895f75 Thanks @HiDeoo! - Adds a new HookParameters utility type to get the type of a plugin hook’s arguments.

  • #2578 f895f75 Thanks @HiDeoo! - Adds a new useTranslations() callback function to the Starlight plugin config:setup hook to generate a utility function to access UI strings for a given language.

  • #2578 f895f75 Thanks @HiDeoo! - Adds a new absolutePathToLang() callback function to the Starlight plugin config:setup to get the language for a given absolute file path.

Patch Changes

@github-actions github-actions bot added the 🌟 core Changes to Starlight’s main package label Feb 5, 2025
Copy link

netlify bot commented Feb 5, 2025

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit ff90cef
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/67b06f6bbff8b8000804c8e7
😎 Deploy Preview https://deploy-preview-2861--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Collaborator Author

astrobot-houston commented Feb 5, 2025

size-limit report 📦

Path Size
/index.html 6.93 KB (0%)
/_astro/*.js 25.76 KB (0%)
/_astro/*.css 13.8 KB (0%)

@github-actions github-actions bot force-pushed the changeset-release/main branch 8 times, most recently from 244cb76 to 8597829 Compare February 11, 2025 15:14
@github-actions github-actions bot force-pushed the changeset-release/main branch 5 times, most recently from 7c29b58 to 7099676 Compare February 15, 2025 09:57
@github-actions github-actions bot force-pushed the changeset-release/main branch from 7099676 to e1fc801 Compare February 15, 2025 10:33
@github-actions github-actions bot added the 🌟 docsearch Changes to Starlight’s DocSearch plugin label Feb 15, 2025
@delucis delucis merged commit 9b32c6a into main Feb 15, 2025
15 checks passed
@delucis delucis deleted the changeset-release/main branch February 15, 2025 10:46
@trueberryless
Copy link
Contributor

I love that you guys really think of everything! ♥️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 core Changes to Starlight’s main package 🌟 docsearch Changes to Starlight’s DocSearch plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants