docs: lead with firmware integration testing for CI/CD#42
Merged
Conversation
Make the headline use case — testing real firmware in CI without flaky or hanging builds — the front door of the docs, using the patterns proven in PyMCU's suite. - Rewrite guides/ci-validation.md into an end-to-end guide: test-project setup, the PicoSimulation(withUsbCdc: false) bare-metal pattern, GPIO/UART assertions (blink sampling, banner + byte-echo round-trip), bounded RunUntilHalt, an on-the-fly firmware compile cache (Lazy + semaphore, OneTimeSetUp), a GitHub Actions snippet, and the headless runner CLI. - Landing: hero now shows a firmware test (not a raw Run loop); add a linked "Firmware testing in CI" card. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Deploying rp2040sharp-docs with
|
| Latest commit: |
eb24b25
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://34e7e9c7.rp2040sharp-docs.pages.dev |
| Branch Preview URL: | https://docs-ci-testing-guide.rp2040sharp-docs.pages.dev |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Reworks the docs so the headline use case — firmware integration testing in CI/CD — is
the front door, using the patterns proven in PyMCU's integration suite.
guides/ci-validation.mdrewritten end-to-end: test-project setup (NuGet TestKit,NUnit, FluentAssertions), the
PicoSimulation(withUsbCdc: false)bare-metal pattern,GPIO assertions (blink sampling), UART assertions (banner + byte-echo round-trip with
InjectByte), boundedRunUntilHalt, an on-the-fly firmware compile cache(
Lazy<byte[]>+SemaphoreSlim, driven from[OneTimeSetUp]), a GitHub Actionssnippet, and the headless runner CLI.
Runloop, and alinked "Firmware testing in CI" card leads the feature grid.
Docs-only. Builds clean with
sphinx-build -W.Type of change
Checklist
dotnet test)