Skip to content

Conversation

@dependabot
Copy link
Contributor

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

Bumps @astrojs/starlight from 0.31.1 to 0.32.2.

Release notes

Sourced from @​astrojs/starlight's releases.

@​astrojs/starlight@​0.32.2

Patch Changes

@​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.

  • ... (truncated)

    Changelog

    Sourced from @​astrojs/starlight's changelog.

    0.32.2

    Patch Changes

    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.

    ... (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.2.
    - [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:development
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <[email protected]>
    @dependabot dependabot bot requested a review from a team as a code owner February 28, 2025 20:42
    @dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Feb 28, 2025
    @dependabot dependabot bot requested a review from KianNH February 28, 2025 20:42
    @github-actions
    Copy link
    Contributor

    Howdy and thanks for contributing to our repo. We review new, external PRs within 2 weeks. If it's been longer than then without any movement, tag the PR Assignees in a comment.

    @KianNH
    Copy link
    Member

    KianNH commented Mar 3, 2025

    Dupe of #20478

    @KianNH KianNH closed this Mar 3, 2025
    @dependabot @github
    Copy link
    Contributor Author

    dependabot bot commented on behalf of github Mar 3, 2025

    OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

    If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

    @dependabot dependabot bot deleted the dependabot/npm_and_yarn/astrojs/starlight-0.32.2 branch March 3, 2025 22:43
    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 size/s

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants