Repository navigation
Correct the release caution before tagging v0.1.1 - #4
Merged
Merged
Conversation
The generated notes open with a CAUTION block, which is the one part of a release anybody is obliged to read, and it says the hardware adapters "do not exist yet". They do: kiln_hal_esp32s3 is in the tree, the hardware configuration builds, and CI has built it on every push since the day that the first build of it turned up two -Wformat-truncation errors. Tagging v0.1.1 against this file would have published that sentence as a safety statement about a kiln controller, so it is corrected before the tag rather than after it. What the block says now, which is both true and less comfortable: the published image is still the simulated one and drives no outputs, the hardware configuration builds, and **none of it has run against a board** -- no thermocouple front end, no SSR, no contactor, no current transformer, no supervisor link, no display. The charge-pump release of SWA-05, the central safety property of the design, cannot be verified anywhere but on hardware. The hardware image stays out of the release deliberately, and the notes now say why: an image that looks flashable and has never driven a contactor is the most dangerous artefact this repository could offer. "Built" is not the bar for dropping --prerelease either; "run" is, and the comment there says so.
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.
The generated release notes open with a
[!CAUTION]block stating that the hardware adapterskiln_hal_esp32s3do not exist yet. They do, and the hardware configuration has been built by CI on every push since the first build of it turned up two-Wformat-truncationerrors.Tagging
v0.1.1against the current file would publish that sentence as a safety statement about a kiln controller, so this goes in first.The corrected block is both accurate and less comfortable than the old one:
SWA-05, the central safety property of the design, can only be verified on hardware.The hardware image stays out of the release, and the notes now say why: an image that looks flashable and has never driven a contactor is the most dangerous thing this repository could offer. The
--prereleasecomment is corrected on the same point — "built" is not the bar for dropping it, "run" is.Workflow-only change;
yaml.safe_loadparses it. After this merges,v0.1.1gets tagged onmain.