Header cleanup + first CI (compile examples)#1
Merged
Conversation
Replace the retired "@jonfroehlich / jonfroehlich.github.io" footer lines (per the canonical docs/sketch-header-template.md in the arduino repo) with the shared footer used across the lab's repos, and add an SPDX-License-Identifier so the MIT license travels with any single header a student copies out. Keep the Doxygen @author tag, and preserve the specific OLED lesson link as a "Learn more" line on the files that had it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
First CI for the library — the floor that mirrors the arduino repo's setup. Uses arduino/compile-sketches to build every sketch in examples/ against Uno, installing this repo plus the Adafruit SSD1306 / GFX / BusIO dependencies. Verified locally: all six examples compile clean. Board list is a matrix so coverage (e.g. ESP32) can be added once confirmed. Off-device unit tests for the pure-logic classes are a planned follow-up. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This was referenced Jun 25, 2026
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.
First pass of v2.0 housekeeping for the library: fix a doc-comment compile bug, align the header footers with the lab's shared convention, and add the floor of CI so broken code can't land silently (this library is published on the Arduino registry).
Commits
@compile error inButton.hpp— inline/* */block comments inside the/** */Doxygen@codeexample prematurely closed the doc comment ("stray '@' in program"). Switched to//line comments inside@code..hppheader footers + add SPDX — replaced the retired@jonfroehlich/jonfroehlich.github.iolines (perdocs/sketch-header-template.mdin the arduino repo) with the shared footer used across the lab's repos, addedSPDX-License-Identifier: MITso the license travels with any single header a student copies out, kept the Doxygen@authortag, and preserved the specific OLED lesson links.arduino/compile-sketchesbuilds every sketch inexamples/on push/PR againstarduino:avr:uno, installing this repo plus the Adafruit SSD1306 / GFX / BusIO dependencies.Verification
arduino:avr:uno./**…*/doc blocks balanced across all 10 headers after the footer sweep.Follow-ups (tracked in separate issues)
MovingAverageFilter,Shapecollision,ColorName).🤖 Generated with Claude Code