Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulosfjunior merged 1 commit into from
Sep 22, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ All notable changes to this project are documented here. The format follows

## [Unreleased]

### Fixed

- The onboarding guide no longer serves `uses: Tooark/ci-security-scanner@v1.1.0`
as `[email protected]`. Cloudflare proxies `tooark.com` and its Email Address
Obfuscation rewrites anything shaped like an address; `name@vX.Y.Z` qualifies.
The affected spans now carry Cloudflare's `email_off` opt-out.
- The `[1.0.0]` and `[1.1.0]` links at the bottom of this file pointed at a
`v1.0.0` tag that was never pushed, so both 404'd.

## [1.1.0] - 2026-09-22

### Added
Expand Down Expand Up @@ -56,7 +65,8 @@ All notable changes to this project are documented here. The format follows

## [1.0.0] - 2026-09-21

First release. Pins `ghcr.io/tooark/security-scanner:1.9`.
First release. Pins `ghcr.io/tooark/security-scanner:1.9`. Never published as
a tag — this content first reached consumers as part of 1.1.0.

### Added

Expand Down Expand Up @@ -97,5 +107,5 @@ First release. Pins `ghcr.io/tooark/security-scanner:1.9`.
writing findings into an uploaded artifact.

[Unreleased]: https://github.com/Tooark/ci-security-scanner/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/Tooark/ci-security-scanner/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/Tooark/ci-security-scanner/releases/tag/v1.0.0
[1.1.0]: https://github.com/Tooark/ci-security-scanner/releases/tag/v1.1.0
[1.0.0]: https://github.com/Tooark/ci-security-scanner/commit/56263b1c4c085d5ce785ed263194c04609b8f0be
12 changes: 9 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -891,7 +891,13 @@ <h2>Mapa do repositório</h2>
</div>
</section>

<!-- ============ 05 ============ -->
<!--
NOTE: version references shaped like name@vX.Y.Z are wrapped in
<!- -email_off- -> below. Cloudflare proxies tooark.com and its Email
Address Obfuscation rewrites them into "[email protected]" links.
Keep the wrappers when bumping the version.
-->
<!-- ============ 05 ============ -->
<section id="github">
<span class="h2-num">05</span>
<h2>A fachada GitHub: <code>action.yml</code></h2>
Expand All @@ -900,7 +906,7 @@ <h2>A fachada GitHub: <code>action.yml</code></h2>
</p>

<p>
Quando alguém escreve <code>uses: Tooark/ci-security-scanner@v1.1.0</code>, o GitHub baixa este
Quando alguém escreve <code><!--email_off-->uses: Tooark/ci-security-scanner@v1.1.0<!--/email_off--></code>, o GitHub baixa este
repositório e executa os passos declarados aqui <em>dentro do job de quem chamou</em>. O arquivo
tem quatro blocos.
</p>
Expand Down Expand Up @@ -1065,7 +1071,7 @@ <h3>O caminho completo de uma execução</h3>
<rect x="6" y="56" width="168" height="84" rx="4" fill="var(--surface)" stroke="var(--rule)" stroke-width="1"></rect>
<text x="90" y="42" text-anchor="middle" font-family="JetBrains Mono, monospace" font-size="11" fill="var(--accent)">1</text>
<text x="90" y="88" text-anchor="middle" font-family="Archivo, sans-serif" font-size="14.5" font-weight="600" fill="var(--ink)">workflow do time</text>
<text x="90" y="108" text-anchor="middle" font-family="JetBrains Mono, monospace" font-size="11" fill="var(--ink-2)">uses: ...@v1.1.0</text>
<text x="90" y="108" text-anchor="middle" font-family="JetBrains Mono, monospace" font-size="11" fill="var(--ink-2)"><!--email_off-->uses: ...@v1.1.0<!--/email_off--></text>
<text x="90" y="126" text-anchor="middle" font-family="JetBrains Mono, monospace" font-size="11" fill="var(--ink-3)">with: command, image</text>
<line x1="174" y1="98" x2="192" y2="98" stroke="var(--rule-strong)" stroke-width="1.4" marker-end="url(#arw)"></line>

Expand Down
Loading