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

Update dependency @astrojs/starlight to ^0.32.0 #71

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 14, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@astrojs/starlight (source) ^0.29.0 -> ^0.32.0 age adoption passing confidence

Release Notes

withastro/starlight (@​astrojs/starlight)

v0.32.0

Compare Source

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:

v0.31.1

Compare Source

Patch Changes

v0.31.0

Compare Source

Minor Changes
  • #​2777 88f4214 Thanks @​hippotastic! - Updates astro-expressive-code dependency to the latest version (0.40).

    This includes an update to the latest Shiki version (1.26.1), providing access to all current Shiki themes and syntax highlighting languages, and adding the config options shiki.engine, shiki.bundledLangs, shiki.langAlias and removeUnusedThemes. It also adds new style variants to the optional collapsible sections plugin.

    See the Expressive Code release notes for full details.

  • #​2736 29a885b Thanks @​delucis! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 5.1.5

    Please update Astro and Starlight together:

    npx @​astrojs/upgrade
  • #​2728 e187383 Thanks @​delucis! - Updates minimum Pagefind dependency to v1.3.0, sets new defaults for Pagefind’s ranking options, and adds support for manually configuring the ranking options

    The new ranking option defaults have been evaluated against Starlight’s own docs to improve the quality of search results. See “Customize Pagefind's result ranking” for more details about how they work.

  • #​157 23bf960 Thanks @​tony-sull! - Adds a print stylesheet to improve the appearance of Starlight docs pages when printed

  • #​2728 e187383 Thanks @​delucis! - Fixes Pagefind logging to respect the Astro log level. When using Astro’s --verbose or --silent CLI flags, these are now respected by Pagefind as well.

Patch Changes
  • #​2792 412effb Thanks @​dhruvkb! - Uses semantic var(--sl-color-hairline) for the page sidebar border instead of var(--sl-color-gray-6). This is visually the same as previously but makes it easier to override the hairline color consistently across a site.

  • #​2736 29a885b Thanks @​delucis! - Updates internal dependencies @astrojs/sitemap and @astrojs/mdx to the latest versions

  • #​2782 d9d415b Thanks @​delucis! - Fixes a documentation link in the JSDoc comment for the StarlightExpressiveCodeOptions type

  • #​2708 442c819 Thanks @​delucis! - Fixes colour contrast correction in code blocks

v0.30.6

Compare Source

Patch Changes

v0.30.5

Compare Source

Patch Changes

v0.30.4

Compare Source

Patch Changes

v0.30.3

Compare Source

Patch Changes

v0.30.2

Compare Source

Patch Changes
  • #​2702 02d16f3 Thanks @​HiDeoo! - Fixes an issue with autogenerated sidebars when using Starlight with Astro's new Content Layer API with directories containing spaces or special characters.

  • #​2704 fd16470 Thanks @​delucis! - Fixes display of focus indicator around site title

v0.30.1

Compare Source

Patch Changes
  • #​2688 5c6996c Thanks @​HiDeoo! - Fixes an issue with autogenerated sidebars when using Starlight with Astro's new Content Layer API where group names would be sluggified.

v0.30.0

Compare Source

Minor Changes
Upgrade Astro and dependencies

⚠️ BREAKING CHANGE: Astro v4 is no longer supported. Make sure you update Astro and any other official integrations at the same time as updating Starlight:

npx @​astrojs/upgrade

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

Update your collections

⚠️ BREAKING CHANGE: Starlight's internal content collections, which organize, validate, and render your content, have been updated to use Astro's new Content Layer API and require configuration changes in your project.

  1. Move the content config file. This file no longer lives within the src/content/config.ts folder and should now exist at src/content.config.ts.

  2. Edit the collection definition(s). To update the docs collection, a loader is now required:

     // src/content.config.ts
     import { defineCollection } from "astro:content";
    +import { docsLoader } from "@​astrojs/starlight/loaders";
     import { docsSchema } from "@​astrojs/starlight/schema";
    
     export const collections = {
    -  docs: defineCollection({ schema: docsSchema() }),
    +  docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
     };

    If you are using the i18n collection to provide translations for additional languages you support or override our default labels, you will need to update the collection definition in a similar way and remove the collection type which is no longer available:

     // src/content.config.ts
     import { defineCollection } from "astro:content";
    +import { docsLoader, i18nLoader } from "@​astrojs/starlight/loaders";
     import { docsSchema, i18nSchema } from "@​astrojs/starlight/schema";
    
     export const collections = {
    -  docs: defineCollection({ schema: docsSchema() }),
    +  docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
    -  i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
    +  i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }),
     };
  3. Update other collections. To update any other collections you may have, follow the “Updating existing collections” section in the Astro 5 upgrade guide.

If you are unable to make any changes to your collections at this time, including Starlight's default docs and i18n collections, you can enable the legacy.collections flag to upgrade to v5 without updating your collections. This legacy flag exists to provide temporary backwards compatibility, and will allow you to keep your collections in their current state until the legacy flag is no longer supported.

Patch Changes

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the automerge label Dec 14, 2024
Copy link
Contributor Author

renovate bot commented Dec 14, 2024

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm error code ERESOLVE
npm error ERESOLVE unable to resolve dependency tree
npm error
npm error While resolving: [email protected]
npm error Found: [email protected]
npm error node_modules/astro
npm error   astro@"^4.0.0" from the root project
npm error
npm error Could not resolve dependency:
npm error peer astro@"^5.1.5" from @astrojs/[email protected]
npm error node_modules/@astrojs/starlight
npm error   @astrojs/starlight@"^0.32.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /runner/cache/others/npm/_logs/2025-02-28T22_52_42_592Z-eresolve-report.txt
npm error A complete log of this run can be found in: /runner/cache/others/npm/_logs/2025-02-28T22_52_42_592Z-debug-0.log

Copy link

netlify bot commented Dec 14, 2024

Deploy Preview for documentation-ngl failed. Why did it fail? →

Name Link
🔨 Latest commit 731b8f6
🔍 Latest deploy log https://app.netlify.com/sites/documentation-ngl/deploys/67c23e41b1ab790008edecb7

@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch 2 times, most recently from ea8c41c to d37b2b6 Compare January 13, 2025 12:30
@renovate renovate bot changed the title Update dependency @astrojs/starlight to ^0.30.0 Update dependency @astrojs/starlight to ^0.31.0 Jan 13, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from d37b2b6 to 6f04c85 Compare January 23, 2025 20:25
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 6f04c85 to ac1fd23 Compare February 15, 2025 14:58
@renovate renovate bot changed the title Update dependency @astrojs/starlight to ^0.31.0 Update dependency @astrojs/starlight to ^0.32.0 Feb 15, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from ac1fd23 to 731b8f6 Compare February 28, 2025 22:52
Copy link

mergeable bot commented Feb 28, 2025

/aviator merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants