Skip to content

test(docs): compile public snippets - #69

Merged
thomhurst merged 3 commits into
mainfrom
issue-34-doc-snippets
Aug 21, 2026
Merged

test(docs): compile public snippets#69
thomhurst merged 3 commits into
mainfrom
issue-34-doc-snippets

Conversation

@thomhurst

Copy link
Copy Markdown
Owner

Closes #34.

Extracts C# directly from README/Docusaurus Markdown, compiles 80 complete snippets against locally packed Kevlar, DI, HTTP, and analyzer packages, and executes the documented pipeline description plus fail-fast composition behavior. Nine contextual fragments have explicit inline exclusion reasons. Shell package IDs and project paths are validated separately; new unmarked C# fences compile by default.

Validation:

  • dotnet pack Kevlar.slnx -c Release -p:Version=0.0.0-docs.2
  • pwsh scripts/Verify-DocSnippets.ps1 -PackagesPath artifacts/package/release -Version 0.0.0-docs.2
  • dotnet build Kevlar.slnx -c Release --no-incremental
  • dotnet run --project tests/Kevlar.Tests -c Release --no-build -- --timeout 5m
  • dotnet run --project tests/Kevlar.IntegrationTests -c Release --no-build -- --timeout 5m
  • dotnet run --project tests/Kevlar.Analyzers.Tests -c Release --no-build -- --timeout 5m
  • dotnet run --project tests/Kevlar.NetStandard.Tests -c Release --no-build -- --timeout 5m
  • npm run build (docs)

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@thomhurst, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 11 minutes

Limit details: You’ve used all 10 included reviews currently available.

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

Wait for the limit to reset, then comment @coderabbitai review or push new commits to the PR.

An organization admin can change what happens after included review limits in Billing.

How do review limits work?

CodeRabbit enforces per-developer PR review limits within each organization.

For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fbc220f2-3488-4abe-8d9a-7e2f3043f6ca

📥 Commits

Reviewing files that changed from the base of the PR and between c7ddbb2 and a0402a2.

📒 Files selected for processing (18)
  • .github/workflows/ci.yml
  • Directory.Packages.props
  • README.md
  • docs/docs/composition.md
  • docs/docs/custom-strategies.md
  • docs/docs/dependency-injection.md
  • docs/docs/executing.md
  • docs/docs/getting-started.md
  • docs/docs/handling-failures.md
  • docs/docs/library-authors.md
  • docs/docs/observability.md
  • docs/docs/strategies/circuit-breaker.md
  • docs/docs/strategies/fallback.md
  • docs/docs/strategies/retry.md
  • docs/docs/testing.md
  • scripts/Verify-DocSnippets.ps1
  • tests/Kevlar.DocTests/Kevlar.DocTests.csproj
  • tests/Kevlar.DocTests/Program.cs

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 17a9a8be6e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread tests/Kevlar.DocTests/Kevlar.DocTests.csproj Outdated
@thomhurst
thomhurst force-pushed the issue-34-doc-snippets branch from 17a9a8b to 13aa1a5 Compare August 21, 2026 13:09

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 13aa1a58cb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread scripts/Verify-DocSnippets.ps1 Outdated
@thomhurst
thomhurst force-pushed the issue-34-doc-snippets branch from 13aa1a5 to a0402a2 Compare August 21, 2026 13:21
@thomhurst
thomhurst merged commit a6f6100 into main Aug 21, 2026
7 checks passed
@thomhurst
thomhurst deleted the issue-34-doc-snippets branch August 21, 2026 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test(docs): compile and execute every public code sample

1 participant