Skip to content

Commit

Permalink
Merge pull request #15 from trueberryless-org/changeset-release/main
Browse files Browse the repository at this point in the history
[ci] release
  • Loading branch information
trueberryless authored Jan 1, 2025
2 parents 82ef707 + 7eb1969 commit e0ca7c4
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 62 deletions.
5 changes: 0 additions & 5 deletions .changeset/afraid-feet-draw.md

This file was deleted.

11 changes: 0 additions & 11 deletions .changeset/eleven-birds-hang.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/honest-crabs-wait.md

This file was deleted.

24 changes: 0 additions & 24 deletions .changeset/lemon-ties-think.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/nice-llamas-rush.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/small-boxes-hunt.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/wet-parrots-tan.md

This file was deleted.

15 changes: 15 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# starlight-plugin-show-latest-version-docs

## 0.3.0

### Minor Changes

- [#16](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/16) [`3de9964`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/3de9964f4860928c42754c94e8be1c246b1cc674) Thanks [@trueberryless](https://github.com/trueberryless)! - Add `@astrojs/node` adapter

- [#16](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/16) [`bdc461c`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/bdc461cc67ff9093795f47127db15952a22c9e22) Thanks [@trueberryless](https://github.com/trueberryless)! - Update documentation for [`server:defer`](https://docs.astro.build/en/reference/directives-reference/#serverdefer), [server adapters](https://docs.astro.build/en/guides/on-demand-rendering/#server-adapters) and component exported by the plugin.

### Patch Changes

- [#14](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/14) [`522ac54`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/522ac548e141d809e31c73a14ae368aad5a9b1ee) Thanks [@trueberryless](https://github.com/trueberryless)! - Update documentation for new `source` configuration

- Updated dependencies [[`3de9964`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/3de9964f4860928c42754c94e8be1c246b1cc674), [`3de9964`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/3de9964f4860928c42754c94e8be1c246b1cc674), [`8b0c933`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/8b0c933c19b1fc1ed035e85a45168c0ec1b4f3a7), [`ae72935`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/ae72935cbdca23c5e7d880d4f0c82c57c328e874)]:
- starlight-plugin-show-latest-version@0.3.0

## 0.2.0

### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "starlight-plugin-show-latest-version-docs",
"version": "0.2.0",
"version": "0.3.0",
"description": "Show the latest released version of your package in your documentation.",
"keywords": [
"starlight",
Expand Down
39 changes: 39 additions & 0 deletions packages/starlight-plugin-show-latest-version/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# starlight-plugin-show-latest-version

## 0.3.0

### Minor Changes

- [#16](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/16) [`3de9964`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/3de9964f4860928c42754c94e8be1c246b1cc674) Thanks [@trueberryless](https://github.com/trueberryless)! - Use [`server:defer`](https://docs.astro.build/en/reference/directives-reference/#serverdefer) in the `SiteTitle.astro` override component if [`showInSiteTitle`](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#showinsitetitle) is set to `"deferred"`.

⚠️ **BREAKING CHANGE:** You now have to use some [server adapter](https://docs.astro.build/en/guides/on-demand-rendering/#server-adapters) if you set [`showInSiteTitle`](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#showinsitetitle) to `"deferred"`.

If you set the [`showInSiteTitle` configuration option](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#showinsitetitle) to `"deferred"`, you have to add a [server adapter](https://docs.astro.build/en/guides/on-demand-rendering/#server-adapters) because the plugin override now uses [`server:defer`](https://docs.astro.build/en/reference/directives-reference/#serverdefer) in order to fetch the latest version on-demand.

Read more about Server Islands in [this blog post](https://astro.build/blog/future-of-astro-server-islands/) or the [Astro documentation](https://docs.astro.build/en/guides/server-islands/).

- [#14](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/14) [`8b0c933`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/8b0c933c19b1fc1ed035e85a45168c0ec1b4f3a7) Thanks [@trueberryless](https://github.com/trueberryless)! - Add version support for NPM and GitLab.

⚠️ **BREAKING CHANGE:** The configuration interface changed.

Please follow the steps below to use the plugin like before or read the [documentation](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#source) for the newly defined API.

Change the removed `repo` configuration to the new [`source`](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#source) configuration object:

```diff
// astro.config.ts
starlightPluginShowLatestVersion({
- repo: "${slug}",
+ source: {
+ type: "github",
+ slug: "${slug}",
+ },
}),
```

Note that you can now use `"npm"`, `"github"` or `"gitlab"` as the source type. This means that the plugin can be better customised to where you publish and release your packages.

### Patch Changes

- [#16](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/16) [`3de9964`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/3de9964f4860928c42754c94e8be1c246b1cc674) Thanks [@trueberryless](https://github.com/trueberryless)! - Make override of Starlight `SiteTitle.astro` optional. You now have to opt-in by setting the new [`showInSiteTitle`](https://starlight-plugin-show-latest-version.trueberryless.org/configuration/#showinsitetitle) configuration option to `"true"` because it does not get overridden by default.

- [#16](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/pull/16) [`ae72935`](https://github.com/trueberryless-org/starlight-plugin-show-latest-version/commit/ae72935cbdca23c5e7d880d4f0c82c57c328e874) Thanks [@trueberryless](https://github.com/trueberryless)! - Add simple [fallback content](https://docs.astro.build/en/guides/server-islands/#server-island-fallback-content) for SiteTitle override Version Badge

## 0.2.0

### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/starlight-plugin-show-latest-version/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "starlight-plugin-show-latest-version",
"version": "0.2.0",
"version": "0.3.0",
"description": "Show the latest released version of your package in your documentation.",
"keywords": [
"starlight",
Expand Down

0 comments on commit e0ca7c4

Please sign in to comment.