Write upstream-version state file as CRLF to honor the JSON rule - #172
Merged
Conversation
check-upstream-version-task wrote the state file LF, but .editorconfig defaults .json to CRLF (so Windows vanilla-editor saves don't churn). The LF output contradicted that rule: a CRLF save flipped the file and the next run rewrote it to LF, a spurious canonicalize bump. Write CRLF instead (jq emits LF; convert on write), matching the rule with no per-file carve-out. Closes #170 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the reusable check-upstream-version-task.yml workflow to write the upstream version state JSON file using CRLF line endings, aligning the workflow output with the repository's .editorconfig rule for *.json and preventing churn/spurious PRs caused by LF/CRLF flips.
Changes:
- Convert
jq's LF output to CRLF when writing the committedupstream-version.json(or configuredstate-file) to match.editorconfig. - Update the inline workflow comment to document why CRLF is required for the state file and how the conversion is done.
ptr727
added a commit
to ptr727/ESPHome-NonRoot
that referenced
this pull request
Jun 21, 2026
Re-sync the carried check-upstream-version-task.yml to write the state file as CRLF (jq emits LF), honoring .editorconfig's .json rule, and convert upstream-version.json to CRLF to match. Converges on ptr727/ProjectTemplate#172, which resolved the LF-vs-CRLF state-file nuance filed in #170.
ptr727
added a commit
to ptr727/ESPHome-NonRoot
that referenced
this pull request
Jun 21, 2026
* Adopt canonical upstream-version tracker for multi-key state Replace the bespoke check-esphome-version.yml with the carried check-upstream-version-task.yml plus a thin scheduled entry-point (check-upstream-version.yml) whose resolver prints the esphome and device-builder versions as a JSON object. Rename the state file esphome-version.json -> upstream-version.json (keyed esphome and device_builder, sorted JSON) and point build-docker-task.yml, the merge-bot refs (upstream-version-<base>), and the PR paths-filter at it. Converges on ptr727/ProjectTemplate#169, which added structured multi-key state to the canonical task per the gap filed in #168. Closes #66. * Write upstream-version state file as CRLF per template fix Re-sync the carried check-upstream-version-task.yml to write the state file as CRLF (jq emits LF), honoring .editorconfig's .json rule, and convert upstream-version.json to CRLF to match. Converges on ptr727/ProjectTemplate#172, which resolved the LF-vs-CRLF state-file nuance filed in #170. * Harden upstream resolver curl error reporting Add --show-error/--location to the PyPI curl calls and emit ::error:: annotations on resolve failure, so a failed scheduled run surfaces a clear cause. Addresses Copilot review feedback on PR #67. * Use product names in resolver errors and tracker wording Reference ESPHome and esphome-device-builder (the PyPI/product names) in the resolve-failure messages, and update the remaining "ESPHome-version bump" mention in AGENTS.md to "upstream-version bump". Addresses Copilot review feedback on PR #67.
ptr727
added a commit
that referenced
this pull request
Jun 22, 2026
… quota (#180) Promote accumulated `develop` work to `main` so derived repos can re-sync from `main` (the stable ref) rather than tracking `develop`. Docs / CI / config only — no `version.json` bump (no functional change). ## Notable contents - **Consolidate code style + carry contract** (#178, closes #175): one root `CODESTYLE.md` (General → .NET → Python, droppable sections); `PyPiLibrary/CODESTYLE.md` removed; `CODESTYLE.md` + `.vscode/tasks.json` added to the verbatim-carry list; official-tooling casing (`.Net*` → `.NET*`); clean-compile rule; brownfield/suppression scope hierarchy; `dependsOrder: sequence` on the `.NET Format` task. - **Clarify project-rule home + harden Copilot runbook** (#173): project conventions/API contracts live in `AGENTS.md`, not `.github/copilot-instructions.md`; a no-inline-comment review is a clean pass; poll for the auto-review before self-triggering. - **Cut Actions artifact-storage quota usage** (#179): PR smoke builds no longer upload artifacts nothing consumes. - Plus prior develop work: docs/comment cleanup (#167), `check-upstream-version-task` structured multi-key state (#169) + CRLF state file (#172), `publish-docker-readme-task`, and routine codegen updates. ## Notes - develop → main is **merge-commit only** (preserves develop's commit list as a second-parent reference on `main`). - Merging closes #173 and #175 (their `Closes` keywords reach the default branch). - After merge, the downstream re-sync issues (each updated with the current state) can point at `main`.
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
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.
Closes #170. Supersedes #171 (which took the wrong approach — see below).
Problem
check-upstream-version-task.ymlwrote the state file withprintf '%s\n'on the runner — LF — but.editorconfigdefaults.json/.jsoncto CRLF. The committedupstream-version.jsontherefore contradicted the repo's own rule: open it in an.editorconfig-aware (or vanilla Windows) editor and save, and it flips to CRLF, so the next tracker run rewrites it back to LF — a spuriousCanonicalize upstream version state filePR.Why not carve the file out to LF (the closed #171 / issue option 2)
The whole point of defaulting JSON to CRLF is that Windows vanilla-editor saves don't break things. Carving the state file out to LF inverts that — a Windows save produces CRLF and now violates the carve-out, churning on exactly the platform the CRLF rule protects. So the fix belongs in the task, not in a special case.
Fix (issue option 1)
Write the state file with CRLF, honoring
.editorconfig's rule for.jsonwith no per-file carve-out.jqemits LF, so convert line endings on write:.editorconfigand.gitattributesare untouched.Validation
file→JSON text data,cat -A→^M$line ends) and idempotent: rewriting identical content is byte-for-byte identical, so no churn / no spurious PR.jq -S '.'still round-trips the CRLF file, so the old-state read and union diff are unaffected (comparison is on parsed objects, EOL-agnostic).🤖 Generated with Claude Code