TEST: Dummy board to exercise board validation CI by mattytrentini · Pull Request #36 · mattytrentini/micropython

mattytrentini · 2026-03-26T23:08:38Z

Summary

Temporary PR to test the board validation GitHub Action. Adds a dummy board (TEST_VALIDATE_BOARD) with deliberate issues to exercise the checks.

Expected warnings (no errors):

Missing pins.csv
Empty thumbnail and docs fields
Vendor name "Acme Corp" repeated in product name
Unknown vendor "Acme Corp"
Missing image in micropython-media (should trigger PR comment)

Test plan

Workflow triggers on this PR
Validation script runs (exit 0, warnings only)
PR comment posted about missing micropython-media image

Add tools/validate_board.py and tools/board_schema.json for validating new board definitions in pull requests. The script checks file presence, board.json schema conformance, MCU/vendor validity, URL liveness, and whether board images exist in the micropython-media repository.

Add a GitHub Actions workflow that validates new board definitions in pull requests. Triggered when files under ports/*/boards/ are changed, it runs validate_board.py and posts a PR comment when board images are missing from the micropython-media repository.

github-actions · 2026-03-27T00:03:28Z

Code size report:

Reference:  github/workflows: Add board validation CI check. [5f7fab0]
Comparison: rp2/boards/TEST_VALIDATE_BOARD: Add dummy board for CI testing. [merge of 62468d5]
  mpy-cross:    +0 +0.000% 
   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
      esp32:    +0 +0.000% ESP32_GENERIC
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

The pathspec 'ports/*/boards/*/' matches directory entries but not files within them. Use 'ports/*/boards/**' to match all files recursively.

The newline-separated file list from git diff was being expanded as separate shell commands. Join files with spaces and use a single-line output to ensure all files are passed as arguments to the script.

GitHub Actions annotations are not prominently visible on the PR page. Write all errors and warnings to a JSON file and post them as a formatted PR comment with a results table per board, making issues immediately visible to the PR author.

github-actions · 2026-03-27T03:37:04Z

Code size report:

Reference:  tools: Drop empty thumbnail check from board validation. [1120f0e]
Comparison: rp2/boards/TEST_VALIDATE_BOARD: Add dummy board for CI testing. [merge of e9738aa]
  mpy-cross:    +0 +0.000% 
   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
      esp32:    +0 +0.000% ESP32_GENERIC
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

…ment. The missing images warning is already included in the per-board results table, so the separate section was duplicating information.

The micropython-media repository stores images under boards/{BOARD_NAME}/ not board-images/. Update the URL construction to include the board name in the path.

…mments. Use context.payload.pull_request.number instead of context.issue.number for reliability, and log the comment ID and URL after creation to aid debugging.

…ze bot. The code_size workflow finds and overwrites the first github-actions[bot] comment, clobbering our validation results. Fix by: - Writing results to GITHUB_STEP_SUMMARY (always visible, immune to bots) - Deleting any previous validation comment before creating a fresh one - Generating the comment body in a separate step for reliability

Inline Python in the workflow YAML caused a YAML parse error. Move the markdown formatting into validate_board.py via a new --comment-md flag, keeping the workflow YAML clean and parseable.

The code_size workflow overwrites github-actions[bot] PR comments, clobbering our validation results. Replace the PR comment with a GitHub Actions step summary, which is reliably visible on the workflow run page and cannot be overwritten by other workflows.

A green check gives authors no reason to click through to the step summary. Make warnings also fail the check (exit code 2) so the author sees a red check, clicks Details, and finds the formatted results table explaining what to fix.

The micropython-media image check is a reminder, not something that should block a PR. Add a notice level that is displayed in the step summary but does not affect the exit code. Errors and warnings still fail the check; notices are informational only.

Many servers block automated HEAD/GET requests, causing false positives. Demote URL liveness failures to notices so they don't fail the check.

Post each warning and notice as an individual PR review comment on the relevant file in the diff. Uses subject_type 'file' for file-level comments. Review comments are separate from issue comments, so the code_size workflow cannot overwrite them.

github-actions · 2026-03-29T02:47:07Z

⚠️ Warning: Missing pins.csv. This file is expected for non-generic boards.

github-actions · 2026-03-29T02:47:08Z

⚠️ Warning: Vendor name 'Acme Corp' appears in product name 'Acme Corp Test Board'. The vendor is displayed separately, so it should not be repeated in the product name.

github-actions · 2026-03-29T02:47:09Z

⚠️ Warning: thumbnail is empty. Consider removing it or adding an image.

github-actions · 2026-03-29T02:47:09Z

⚠️ Warning: docs is empty. Consider removing it or adding a docs URL.

github-actions · 2026-03-29T02:47:10Z

ℹ️ Notice: Image(s) not found in micropython-media repository: test_validate_board.jpg. Please submit a corresponding PR to https://github.com/micropython/micropython-media with board images.

The thumbnail field is likely to be removed from board.json. Remove the warning for empty thumbnails to avoid noise. Keep the docs check as its use will be encouraged going forward.

Temporary test board to exercise the board validation GitHub Action. This commit should be removed after testing is complete.

github-actions · 2026-03-31T05:39:13Z

⚠️ Warning: Missing pins.csv. This file is expected for non-generic boards.

github-actions · 2026-03-31T05:39:14Z

⚠️ Warning: Vendor name 'Acme Corp' appears in product name 'Acme Corp Test Board'. The vendor is displayed separately, so it should not be repeated in the product name.

github-actions · 2026-03-31T05:39:14Z

⚠️ Warning: docs is empty. Consider adding a docs URL.

github-actions · 2026-03-31T05:39:15Z

ℹ️ Notice: Image(s) not found in micropython-media repository: test_validate_board.jpg. Please submit a corresponding PR to https://github.com/micropython/micropython-media with board images.

mattytrentini added 2 commits March 27, 2026 09:29

github/workflows: Fix pathspec glob in board validation.

badb3e7

The pathspec 'ports/*/boards/*/' matches directory entries but not files within them. Use 'ports/*/boards/**' to match all files recursively.

mattytrentini force-pushed the test/board-validate-dummy branch from 62468d5 to e33baf3 Compare March 27, 2026 03:13

github/workflows: Fix multiline file list expansion in board validation.

cb535bb

The newline-separated file list from git diff was being expanded as separate shell commands. Join files with spaces and use a single-line output to ensure all files are passed as arguments to the script.

mattytrentini force-pushed the test/board-validate-dummy branch from e33baf3 to 3b4ec8d Compare March 27, 2026 03:20

mattytrentini force-pushed the test/board-validate-dummy branch from 3b4ec8d to 84a8cb2 Compare March 27, 2026 03:34

github/workflows: Remove redundant missing images section from PR com…

d7e3083

…ment. The missing images warning is already included in the per-board results table, so the separate section was duplicating information.

mattytrentini force-pushed the test/board-validate-dummy branch from 84a8cb2 to 119a10f Compare March 27, 2026 03:52

Repository owner deleted a comment from github-actions Bot Mar 27, 2026

mattytrentini added 5 commits March 27, 2026 16:06

tools: Fix micropython-media image path in board validation.

5edd0bf

The micropython-media repository stores images under boards/{BOARD_NAME}/ not board-images/. Update the URL construction to include the board name in the path.

github/workflows: Use explicit PR number and add debug logging for co…

66c298c

…mments. Use context.payload.pull_request.number instead of context.issue.number for reliability, and log the comment ID and URL after creation to aid debugging.

tools/github: Move comment markdown generation into validate_board.py.

7e50400

Inline Python in the workflow YAML caused a YAML parse error. Move the markdown formatting into validate_board.py via a new --comment-md flag, keeping the workflow YAML clean and parseable.

mattytrentini force-pushed the test/board-validate-dummy branch from 119a10f to 9cc7244 Compare March 27, 2026 12:31

tools: Fail board validation check on warnings too.

657a48d

A green check gives authors no reason to click through to the step summary. Make warnings also fail the check (exit code 2) so the author sees a red check, clicks Details, and finds the formatted results table explaining what to fix.

mattytrentini force-pushed the test/board-validate-dummy branch from 9cc7244 to fc73fe1 Compare March 27, 2026 22:36

mattytrentini added 2 commits March 29, 2026 00:05

tools: Make URL liveness check a notice instead of a warning.

414fad2

Many servers block automated HEAD/GET requests, causing false positives. Demote URL liveness failures to notices so they don't fail the check.

mattytrentini force-pushed the test/board-validate-dummy branch from fc73fe1 to 13b397b Compare March 28, 2026 13:35

mattytrentini force-pushed the test/board-validate-dummy branch from 13b397b to 4a71ee0 Compare March 29, 2026 02:44

github-actions Bot reviewed Mar 29, 2026

View reviewed changes

mattytrentini added 2 commits March 31, 2026 14:55

tools: Drop empty thumbnail check from board validation.

1120f0e

The thumbnail field is likely to be removed from board.json. Remove the warning for empty thumbnails to avoid noise. Keep the docs check as its use will be encouraged going forward.

rp2/boards/TEST_VALIDATE_BOARD: Add dummy board for CI testing.

e9738aa

Temporary test board to exercise the board validation GitHub Action. This commit should be removed after testing is complete.

mattytrentini force-pushed the test/board-validate-dummy branch from 4a71ee0 to e9738aa Compare March 31, 2026 05:38

github-actions Bot reviewed Mar 31, 2026

View reviewed changes

mattytrentini force-pushed the feature/board-validate-action branch from 1120f0e to 4737bba Compare April 1, 2026 11:55

mattytrentini mentioned this pull request Apr 2, 2026

Add a board validation check micropython/micropython#19028

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TEST: Dummy board to exercise board validation CI#36

TEST: Dummy board to exercise board validation CI#36
mattytrentini wants to merge 17 commits into
feature/board-validate-actionfrom
test/board-validate-dummy

mattytrentini commented Mar 26, 2026

Uh oh!

github-actions Bot commented Mar 27, 2026

Uh oh!

github-actions Bot commented Mar 27, 2026 •

edited

Loading

Uh oh!

github-actions Bot Mar 29, 2026

Uh oh!

github-actions Bot Mar 29, 2026

Uh oh!

github-actions Bot Mar 29, 2026

Uh oh!

github-actions Bot Mar 29, 2026

Uh oh!

github-actions Bot Mar 29, 2026

Uh oh!

github-actions Bot Mar 31, 2026

Uh oh!

github-actions Bot Mar 31, 2026

Uh oh!

github-actions Bot Mar 31, 2026

Uh oh!

github-actions Bot Mar 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

mattytrentini commented Mar 26, 2026

Summary

Test plan

Uh oh!

github-actions Bot commented Mar 27, 2026

Uh oh!

github-actions Bot commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

github-actions Bot commented Mar 27, 2026 •

edited

Loading