Skip to content

Remove documentation build from CI verification and fix flaky test - #10

Merged
miccy merged 5 commits into
sync/bun-migrationfrom
copilot/sub-pr-5
Feb 3, 2026
Merged

Remove documentation build from CI verification and fix flaky test#10
miccy merged 5 commits into
sync/bun-migrationfrom
copilot/sub-pr-5

Conversation

Copilot AI commented Feb 3, 2026

Copy link
Copy Markdown

Documentation build is being removed from CI verification as it will be moved outside the monorepo in future PRs.

Changes:

  • Removed build:docs from the verify script in package.json
  • Removed scripts/typedoc-plugin-evolu.test.mts test from verification (requires generated docs)
  • Fixed flaky test timeout in packages/common/test/local-first/Protocol.test.ts by increasing timeout from 5s to 15s for the "client and relay each have a random half of the data" E2E sync test
  • Added explanatory comment for the timeout increase (test performs extensive storage operations and reconciliation with large data sets)
  • Execution order: formatbuildtesttest:coveragelintlint-monorepo

Why package.json:
The .github/workflows/ci.yaml file is protected by repository rules, so changes were applied to the verify script itself.

"verify": "bun run format && bun run build && bun run test && bun run test:coverage && bun run lint && bun run lint-monorepo"

This streamlines CI by removing documentation generation and tests that depend on it, while also addressing a flaky test that was causing CI failures in slower environments.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>
Copilot AI changed the title [WIP] Add migration documentation for Bun and Biome Fix CI test failure by ensuring docs build before verification Feb 3, 2026
Copilot AI requested a review from miccy February 3, 2026 12:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes CI failures where scripts/typedoc-plugin-evolu.test.mts ran before TypeDoc-generated .mdx docs existed by ensuring docs are built as part of verify.

Changes:

  • Updated the root verify script to run build:docs before subsequent verification steps.
  • Ensures TypeDoc output exists before the TypeDoc plugin verification test executes.

Comment thread package.json Outdated
"lint-monorepo": "bunx sherif@latest",
"format": "biome format --write .",
"verify": "bun run format && bun run build && bun run test && bun run test:coverage && bun run lint && bun run lint-monorepo && bun vitest run scripts/typedoc-plugin-evolu.test.mts",
"verify": "bun run format && bun run build:docs && bun run build && bun run test && bun run test:coverage && bun run lint && bun run lint-monorepo && bun vitest run scripts/typedoc-plugin-evolu.test.mts",

Copilot AI Feb 3, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build:docs is only required for the final typedoc plugin verification test; running it immediately after format means CI will spend time generating docs even if build/test/lint later fail. Consider moving bun run build:docs to just before bun vitest run scripts/typedoc-plugin-evolu.test.mts to keep the same correctness while reducing wasted CI time on failing runs.

Suggested change
"verify": "bun run format && bun run build:docs && bun run build && bun run test && bun run test:coverage && bun run lint && bun run lint-monorepo && bun vitest run scripts/typedoc-plugin-evolu.test.mts",
"verify": "bun run format && bun run build && bun run test && bun run test:coverage && bun run lint && bun run lint-monorepo && bun run build:docs && bun vitest run scripts/typedoc-plugin-evolu.test.mts",

Copilot uses AI. Check for mistakes.
@miccy

miccy commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

Nepotřebujeme build dokumentace. V dalších PR bude přesunuta mimo monorepo. @copilot vypni build docs a zajisti ať to kvuli tomu nefailuje

Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>

Copilot AI commented Feb 3, 2026

Copy link
Copy Markdown
Author

Nepotřebujeme build dokumentace. V dalších PR bude přesunuta mimo monorepo. @copilot vypni build docs a zajisti ať to kvuli tomu nefailuje

Fixed in commit d62c245. Removed both build:docs and the typedoc plugin test from the verify script. The verify script now runs: format → build → test → test:coverage → lint → lint-monorepo. CI will no longer build docs or run tests that depend on generated documentation.

Copilot AI changed the title Fix CI test failure by ensuring docs build before verification Remove documentation build from CI verification Feb 3, 2026
Copilot AI requested a review from miccy February 3, 2026 12:46
@miccy

miccy commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

@copilot CI znovu fail. Zjisti chybu a udělej fix

@miccy miccy added bug Something isn't working fix Repair any bug labels Feb 3, 2026
Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>

Copilot AI commented Feb 3, 2026

Copy link
Copy Markdown
Author

@copilot CI znovu fail. Zjisti chybu a udělej fix

Fixed in commit 0a8f3ea. The CI was failing due to a flaky test timeout in test/local-first/Protocol.test.ts (not related to the docs build removal). Increased the timeout for the test from 5s to 15s to handle slower CI environments.

Co-authored-by: miccy <9729864+miccy@users.noreply.github.com>
Copilot AI changed the title Remove documentation build from CI verification Remove documentation build from CI verification and fix flaky test Feb 3, 2026
Copilot AI requested a review from miccy February 3, 2026 13:01
@miccy
miccy marked this pull request as ready for review February 3, 2026 13:05
@coderabbitai

coderabbitai Bot commented Feb 3, 2026

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review

Comment @coderabbitai help to get the list of available commands and usage tips.

@miccy
miccy merged commit 4175e1b into sync/bun-migration Feb 3, 2026
2 checks passed
@miccy
miccy deleted the copilot/sub-pr-5 branch February 10, 2026 01:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working fix Repair any bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants