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

Bump @astrojs/starlight from 0.31.1 to 0.32.1 #221

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 24, 2025

Bumps @astrojs/starlight from 0.31.1 to 0.32.1.

Release notes

Sourced from @​astrojs/starlight's releases.

@​astrojs/starlight@​0.32.1

Patch Changes

@​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',
  • ... (truncated)

    Changelog

    Sourced from @​astrojs/starlight's changelog.

    0.32.1

    Patch Changes

    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.

  • ... (truncated)

    Commits

    Dependabot compatibility score

    Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


    Dependabot commands and options

    You can trigger Dependabot actions by commenting on this PR:

    • @dependabot rebase will rebase this PR
    • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
    • @dependabot merge will merge this PR after your CI passes on it
    • @dependabot squash and merge will squash and merge this PR after your CI passes on it
    • @dependabot cancel merge will cancel a previously requested merge and block automerging
    • @dependabot reopen will reopen this PR if it is closed
    • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
    • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
    • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

    Bumps [@astrojs/starlight](https://github.com/withastro/starlight/tree/HEAD/packages/starlight) from 0.31.1 to 0.32.1.
    - [Release notes](https://github.com/withastro/starlight/releases)
    - [Changelog](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md)
    - [Commits](https://github.com/withastro/starlight/commits/@astrojs/[email protected]/packages/starlight)
    
    ---
    updated-dependencies:
    - dependency-name: "@astrojs/starlight"
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <[email protected]>
    @dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Feb 24, 2025
    Copy link

    netlify bot commented Feb 24, 2025

    Deploy Preview for astro-theme-provider ready!

    Name Link
    🔨 Latest commit 7542f71
    🔍 Latest deploy log https://app.netlify.com/sites/astro-theme-provider/deploys/67bbd64f49b321000829ff8f
    😎 Deploy Preview https://deploy-preview-221--astro-theme-provider.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    dependencies Pull requests that update a dependency file
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    0 participants