-
Notifications
You must be signed in to change notification settings - Fork 41
Add changelog page #679
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
Open
dawn-ducky
wants to merge
17
commits into
main
Choose a base branch
from
add-changelog-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add changelog page #679
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
151fd00
Add changelog page
dawn-ducky 68b829a
Fix changelog area to a closed set
dawn-ducky ae97ac8
Make changelog entry headers clickable and align the filter chips
easymac 0f8cc82
Merge branch 'main' into add-changelog-page
AbhishekDoshi26 bfd05a0
Merge branch 'main' into add-changelog-page
AbhishekDoshi26 a55b990
Fix changelog permalinks, copy feedback, and search coverage
AbhishekDoshi26 3cf311f
Serve the changelog as Markdown for agents
AbhishekDoshi26 3d897b3
Give each changelog type badge its own color
AbhishekDoshi26 7a909ad
Merge branch 'main' into add-changelog-page
AbhishekDoshi26 fbcba38
Fix changelog accessibility, text selection, and light-mode styling
AbhishekDoshi26 39ef7e5
Merge branch 'main' into add-changelog-page
AbhishekDoshi26 10ce731
Replace the example changelog entry with real releases
AbhishekDoshi26 d73ec70
Redesign the changelog list as a timeline
AbhishekDoshi26 6748c86
Move changelog entries to Markdown files checked at build
AbhishekDoshi26 b44cb67
Make the changelog discoverable to agents
AbhishekDoshi26 55bec5e
Catch changelog text that renders differently on the page and in .md
AbhishekDoshi26 f953188
Complete 1.6.120-1.6.123 entries and tighten changelog validation
AbhishekDoshi26 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,7 @@ words: | |
| - previewable | ||
| - recompiles | ||
| - riverpod | ||
| - rollforward | ||
| - rollouts | ||
| - rsassa | ||
| - sdkman | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,23 @@ | ||
| import { defineCollection } from 'astro:content'; | ||
| import { glob } from 'astro/loaders'; | ||
| import { docsLoader } from '@astrojs/starlight/loaders'; | ||
| import { docsSchema } from '@astrojs/starlight/schema'; | ||
| import { autoSidebarLoader } from 'starlight-auto-sidebar/loader'; | ||
| import { autoSidebarSchema } from 'starlight-auto-sidebar/schema'; | ||
| import { changelogSchema } from '~/data/changelog-schema'; | ||
|
|
||
| export const collections = { | ||
| docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), | ||
| autoSidebar: defineCollection({ | ||
| loader: autoSidebarLoader(), | ||
| schema: autoSidebarSchema(), | ||
| }), | ||
| // One Markdown file per entry; see `src/content/changelog/_template.md`. | ||
| changelog: defineCollection({ | ||
| loader: glob({ | ||
| base: './src/content/changelog', | ||
| pattern: ['*.md', '!_*.md'], | ||
| }), | ||
| schema: changelogSchema, | ||
| }), | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| # Copy this file to a new name in this folder. The file name becomes the | ||
| # entry's permalink (/changelog/#<name>), so make it short, lowercase, and | ||
| # descriptive, like `patches-rollback-command.md`. Files starting with `_` are | ||
| # not published. | ||
| # | ||
| # Every field below is checked when the site builds, and a mistake fails the | ||
| # build with a message naming this file and the field. | ||
|
|
||
| # A short headline, in sentence case. | ||
| title: Roll patches back from the CLI | ||
| # The day the release shipped, as YYYY-MM-DD with no quotes. Entries from the | ||
| # same day are listed in file name order. | ||
| date: 2026-08-28 | ||
| # The Shorebird CLI release that shipped the change, without a "v". Required | ||
| # for CLI and Flutter changes. Delete this line for a change that didn't ship in | ||
| # the CLI, like a Console, API, or server-side Code Push change. | ||
| version: 1.6.120 | ||
| # One of: Code Push, CLI, Console, API, Flutter | ||
| area: CLI | ||
| # One of: New, Fixed, Changed, Deprecated | ||
| type: New | ||
| # Optional: the docs page to read next. `href` must be a docs page on this | ||
| # site, starting with "/", and a #fragment must match a heading on it. Delete | ||
| # both lines if there's no page for it. | ||
| docLink: | ||
| label: Roll back a patch | ||
| href: /code-push/rollback/ | ||
| --- | ||
|
|
||
| The first paragraph is the summary, which is always shown. Keep it to one or two | ||
| sentences. Wrap commands and flags in backticks, like | ||
| `shorebird patches rollback`. | ||
|
|
||
| - Then a bulleted list with the details, shown when the entry is expanded. | ||
| - Each bullet can wrap onto more lines, as long as they are indented. | ||
|
|
||
| ```sh | ||
| shorebird patches rollback --release-version 1.0.0+1 --patch-number 1 | ||
| ``` | ||
|
|
||
| <!-- | ||
| The code block is optional: one command per line, with no leading `$`. Nothing | ||
| else is allowed in the body besides the summary, the bullets, the code block, | ||
| and comments like this one. | ||
|
|
||
| Backticks are the only formatting. Links and bold aren't supported (put the link | ||
| in docLink), and placeholders like <id> go inside backticks. | ||
| --> |
21 changes: 21 additions & 0 deletions
21
src/content/changelog/failed-patch-checks-for-replacement.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: A patch that fails to load is replaced on the same launch | ||
| date: 2026-09-16 | ||
| version: 1.6.122 | ||
| area: Code Push | ||
| type: Fixed | ||
| docLink: | ||
| label: Patch integrity and automatic rollback | ||
| href: /code-push/rollback/#patch-integrity-and-automatic-rollback | ||
| --- | ||
|
|
||
| When a patch fails to load, the device now checks for a replacement patch on | ||
| that same launch, instead of waiting for the next one. | ||
|
|
||
| - Previously, reporting the failure suppressed the update check, so a device | ||
| couldn't pick up a fixed patch until it launched again. | ||
| - Patch checks now report the patch the device is actually running, so each | ||
| device is attributed to the right patch. | ||
| - These fixes are in the updater built into Shorebird's Flutter engine, so they | ||
| apply to releases built with Shorebird's Flutter 3.47.4 or later, the default | ||
| in CLI 1.6.122. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Flutter 3.47.2 support | ||
| date: 2026-08-28 | ||
| version: 1.6.120 | ||
| area: Flutter | ||
| type: New | ||
| docLink: | ||
| label: Flutter versions | ||
| href: /getting-started/flutter-version/ | ||
| --- | ||
|
|
||
| Shorebird now supports Flutter 3.47.2 and Dart 3.13.2. | ||
|
|
||
| - iOS and macOS: Swift package dependencies are always updated. | ||
| - Windows: fixes hot reload failing on file time truncation. | ||
| - Desktop: `--build-name` and `--build-number` are now forwarded to | ||
| `version.json`. | ||
|
|
||
| ```sh | ||
| shorebird release android --flutter-version=3.47.2 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Flutter 3.47.3 support | ||
| date: 2026-09-14 | ||
| version: 1.6.121 | ||
| area: Flutter | ||
| type: New | ||
| docLink: | ||
| label: Flutter versions | ||
| href: /getting-started/flutter-version/ | ||
| --- | ||
|
|
||
| Shorebird now supports Flutter 3.47.3 and Dart 3.13.3. | ||
|
|
||
| - Android: fixes license detection for cmdline-tools 23.0 and newer. | ||
| - iOS and macOS: a missing Xcode is now handled instead of failing hard. | ||
| - Windows: fixes Dart cross-compilation. | ||
| - B-series PowerVR GPUs no longer use Vulkan. | ||
|
|
||
| ```sh | ||
| shorebird release android --flutter-version=3.47.3 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Flutter 3.47.4 support | ||
| date: 2026-09-16 | ||
| version: 1.6.122 | ||
| area: Flutter | ||
| type: New | ||
| docLink: | ||
| label: Flutter versions | ||
| href: /getting-started/flutter-version/ | ||
| --- | ||
|
|
||
| Shorebird now supports Flutter 3.47.4 and Dart 3.13.3. | ||
|
|
||
| - iOS: native assets now require iOS 15, raised from iOS 13. | ||
| - iOS: a build now warns when Device Support Symbols are missing, instead of | ||
| failing partway through. | ||
| - Windows: Application Control and security policy blocks are handled instead of | ||
| failing the build. | ||
|
|
||
| ```sh | ||
| shorebird release ios --flutter-version=3.47.4 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: Flutter 3.47.5 support | ||
| date: 2026-09-21 | ||
| version: 1.6.123 | ||
| area: Flutter | ||
| type: New | ||
| docLink: | ||
| label: Flutter versions | ||
| href: /getting-started/flutter-version/ | ||
| --- | ||
|
|
||
| Shorebird now supports Flutter 3.47.5 and Dart 3.13.4. | ||
|
|
||
| - iOS: fixes an occasional crash when debugging on physical iOS 27 devices. | ||
| - Widget Previewer: fixes a crash when re-expanding a preview group. | ||
| - A Dart Development Service startup failure is now handled instead of crashing. | ||
|
|
||
| ```sh | ||
| shorebird release ios --flutter-version=3.47.5 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Release with the Flutter version you already use | ||
| date: 2026-09-21 | ||
| version: 1.6.123 | ||
| area: CLI | ||
| type: New | ||
| docLink: | ||
| label: Match the Flutter version you already use | ||
| href: /getting-started/flutter-version/#match-the-flutter-version-you-already-use | ||
| --- | ||
|
|
||
| `--flutter-version` now accepts `fvm` and `system`, so you no longer have to | ||
| look up and repeat your Flutter version number. | ||
|
|
||
| - `--flutter-version=fvm` uses the version fvm resolves for your project from | ||
| its `.fvmrc`. It requires `fvm` on your `PATH`. | ||
| - `--flutter-version=system` uses the version reported by the `flutter` on your | ||
| `PATH`. | ||
| - Shorebird still builds with its own fork of Flutter at that version, not with | ||
| your fvm or system install. A version Shorebird doesn't support fails the same | ||
| way as one you name explicitly. | ||
|
|
||
| ```sh | ||
| shorebird release android --flutter-version=fvm | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: iOS debug symbols now upload to symbol servers | ||
| date: 2026-09-21 | ||
| version: 1.6.123 | ||
| area: CLI | ||
| type: Fixed | ||
| docLink: | ||
| label: Release options | ||
| href: /code-push/release/#options | ||
| --- | ||
|
|
||
| On iOS, `--split-debug-info` now writes a Mach-O dSYM, so symbol servers ingest | ||
| it and Dart stack traces from production become readable. | ||
|
|
||
| - Previously the file was an ELF with no debug ID. Uploads reported finding | ||
| nothing, while still exiting cleanly. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Roll patches back and forward from the CLI | ||
| date: 2026-08-28 | ||
| version: 1.6.120 | ||
| area: CLI | ||
| type: New | ||
| docLink: | ||
| label: Roll back a patch | ||
| href: /code-push/rollback/ | ||
| --- | ||
|
|
||
| `shorebird patches rollback` and `shorebird patches rollforward` do the same as | ||
| the Rollback and Roll Forward actions in the Console. | ||
|
|
||
| - Both take `--release-version` and `--patch-number`. | ||
| - By default, a patch that is already in the requested state is reported and the | ||
| command succeeds. Add `--require-change` to exit with an error instead. | ||
|
|
||
| ```sh | ||
| shorebird patches rollback --release-version 1.0.0+1 --patch-number 1 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: Manage apps from the CLI | ||
| date: 2026-09-14 | ||
| version: 1.6.121 | ||
| area: CLI | ||
| type: New | ||
| docLink: | ||
| label: Transfer an app | ||
| href: /account/orgs/#transfer-an-app | ||
| --- | ||
|
|
||
| New `shorebird apps` commands list, rename, delete, and transfer apps without | ||
| opening the Console. | ||
|
|
||
| - `shorebird apps transfer --org-id <id>` moves an app into another | ||
| organization. Run `shorebird account orgs` to find the id. | ||
| - `shorebird apps rename --name <name>` changes the display name. | ||
| - `shorebird apps delete` has no prompt. Pass `--confirm-name` with the app's | ||
| current display name to confirm. | ||
|
|
||
| ```sh | ||
| shorebird apps transfer --app-id <id> --org-id 42 | ||
| ``` |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.