Skip to content

fix(docs): stop Cloudflare rewriting version refs as email addresses - #10

Merged
paulosfjunior merged 1 commit into
mainfrom
fix/docs-cloudflare-and-links
Sep 22, 2026
Merged

paulosfjunior merged 1 commit into
mainfrom
fix/docs-cloudflare-and-links

Conversation

@paulosfjunior

Copy link
Copy Markdown
Contributor

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:

Quando alguém escreve <code>uses: Tooark/<a href="/cdn-cgi/l/email-protection"
class="__cf_email__" data-cfemail="6a090347190f...">[email&#160;protected]</a></code>

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. That is why restore@v4, checkout@v4 and actionlint@sha256 elsewhere 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 and check-sync.sh section 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.com zone, which is a much wider change for two spans on one page.

2. Both CHANGELOG compare links 404

releases/tag/v1.0.0   HTTP 404
releases/tag/v1.1.0   HTTP 200

v1.0.0 was never pushed as a tag — that content went into the initial commits and first reached consumers as 1.1.0. [1.1.0] pointed at compare/v1.0.0...v1.1.0 and [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 guide
  • Governance / documentation only

Consumer impact

  • No consumer-visible change

Checklist

  • ./scripts/check-sync.sh passes, section 4 included
  • python3 scripts/validate-templates.py passes
  • HTML still balanced — 0 unclosed tags
  • No version pins changed

Merging republishes the guide automatically; the Pages workflow triggers on docs/**.

🤖 Generated with Claude Code

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>
@paulosfjunior
paulosfjunior merged commit e0b215d into main Sep 22, 2026
5 checks passed
@paulosfjunior
paulosfjunior deleted the fix/docs-cloudflare-and-links branch September 22, 2026 19:25
Sign up for free to 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.

1 participant