fix(docs): stop Cloudflare rewriting version refs as email addresses - #10
Merged
Merged
Conversation
The published guide was serving the line that teaches people how to consume the Action as: Quando alguém escreve uses: Tooark/[email protected] Cloudflare proxies tooark.com, and its Email Address Obfuscation rewrites anything shaped like an address. "ci-security-scanner@v1.1.0" qualifies — the dots in the version make the right-hand side look like a domain, which is why "@v4" and "@sha256" elsewhere on the page came through untouched. Two spans were affected: the prose above and a label in the flow diagram. Both now carry Cloudflare's documented email_off opt-out, with a note next to them so the wrappers survive the next version bump. The markers are HTML comments, so the underlying text is unchanged and check-sync.sh still reads the pinned version out of the file. Also fixes the compare links at the bottom of CHANGELOG.md. Both pointed at a v1.0.0 tag that was never pushed — 1.0.0 was folded into the initial commits and the code first reached consumers as 1.1.0 — so both 404'd. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
6 tasks
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.
Two defects found while verifying the 1.1.0 release.
1. The published guide was mangling the most important line
Fetching the live page returned:
Cloudflare proxies
tooark.com, and its Email Address Obfuscation rewrites anything shaped like an address.ci-security-scanner@v1.1.0qualifies — the dots in the version make the right-hand side look like a domain. That is whyrestore@v4,checkout@v4andactionlint@sha256elsewhere on the page came through untouched: no dot, no match.Two spans were affected — the prose explaining how to consume the Action, and a label in the flow diagram.
A visitor with JavaScript sees the decoded text, because Cloudflare injects a decoder. Without JS, before the decoder runs, or for anything reading the page as data, the line reads
[email protected].Fixed with Cloudflare's documented
<!--email_off-->opt-out plus a note next to it, so the wrappers survive the next version bump. The markers are HTML comments, so the underlying text is unchanged andcheck-sync.shsection 4 still reads the pinned version out of the file — verified, section 4 still passes.The alternative was switching Email Address Obfuscation off for the whole
tooark.comzone, which is a much wider change for two spans on one page.2. Both CHANGELOG compare links 404
v1.0.0was never pushed as a tag — that content went into the initial commits and first reached consumers as 1.1.0.[1.1.0]pointed atcompare/v1.0.0...v1.1.0and[1.0.0]at a release that does not exist.Now
[1.1.0]points at its release and[1.0.0]at the commit that carried it, with a line in the 1.0.0 section saying it was never published as a tag so nobody goes hunting.Affected area(s)
docs/— onboarding guideConsumer impact
Checklist
./scripts/check-sync.shpasses, section 4 includedpython3 scripts/validate-templates.pypassesMerging republishes the guide automatically; the Pages workflow triggers on
docs/**.🤖 Generated with Claude Code