Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Write upstream-version state file as CRLF to honor the JSON rule by ptr727 · Pull Request #172 · ptr727/ProjectTemplate · GitHub
Skip to content

Write upstream-version state file as CRLF to honor the JSON rule - #172

Merged
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf
Jun 21, 2026
Merged

Write upstream-version state file as CRLF to honor the JSON rule#172
ptr727 merged 2 commits into
developfrom
upstream-version-state-crlf

Conversation

@ptr727

Copy link
Copy Markdown
Owner

Closes#170. Supersedes #171 (which took the wrong approach — see below).

Problem

check-upstream-version-task.yml wrote the state file with printf '%s\n' on the runner — LF — but .editorconfig defaults .json/.jsonc to CRLF. The committed upstream-version.json therefore 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 spurious Canonicalize upstream version state file PR.

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 .json with no per-file carve-out. jq emits LF, so convert line endings on write:

printf'%s\n'"$new"| sed 's/$/\r/'>"$STATE_FILE"

.editorconfig and .gitattributes are untouched.

Validation

  • Output is CRLF (fileJSON 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).
  • A Windows vanilla-editor save now produces CRLF that matches the committed file.
  • YAML parses.

🤖 Generated with Claude Code

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>
CopilotAI review requested due to automatic review settings June 21, 2026 21:33
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 committed upstream-version.json (or configured state-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.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit 38f46ea into developJun 21, 2026
9 checks passed
@ptr727
ptr727 deleted the upstream-version-state-crlf branch June 21, 2026 22:12
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`.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ptr727