Skip to content

Snowbridge 6.0.1 - #1889

Open
Piotr Poniedziałek (pondzix) wants to merge 2 commits into
mainfrom
snowbridge-6.0.1
Open

Snowbridge 6.0.1#1889
Piotr Poniedziałek (pondzix) wants to merge 2 commits into
mainfrom
snowbridge-6.0.1

Conversation

@pondzix

Copy link
Copy Markdown
Contributor

What changed?

Bump snowbridge to 6.0.1 and document the 6.x release:

  • Add a 6.x upgrade guide covering the HTTP target OAuth2 restructure, the hash helper's change of output, distroless Docker images and the v6 Go module path
  • Document the oauth_client and oauth_jwt blocks on the HTTP target, replacing the stale oauth2_* prose
  • Note the hash helper change on the custom scripts and jq helper pages

Why?

Snowbridge v6 release.

Reviewer guidance

--

AI reviews

Claude will automatically review this PR against the docs style guide.

If you have questions or want it to look again at something specific, tag @claude in a comment.

Bump snowbridge to 6.0.1 and document the 6.x release:

- Add a 6.x upgrade guide covering the HTTP target OAuth2 restructure,
  the hash helper's change of output, distroless Docker images and the
  v6 Go module path
- Document the oauth_client and oauth_jwt blocks on the HTTP target,
  replacing the stale oauth2_* prose
- Note the hash helper change on the custom scripts and jq helper pages
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 29, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation 1c9e302 Commit Preview URL

Branch Preview URL
Jul 29 2026, 02:24 PM

@claude

claude Bot commented Jul 29, 2026

Copy link
Copy Markdown

Style review

Overall this is clear, well-organized documentation — the upgrade guide follows the structure of the existing 5.x guide, the before/after HCL examples are easy to follow, and the distroless section does a good job of spelling out operational consequences. A few style guide items to fix.

1. :::caution is not an approved admonition type

:::caution
Version 6.0.0 changes the values this function returns.

Two occurrences: docs/.../transformations/builtin/reusable/_jqHelpers.md and docs/.../transformations/custom-scripts/index.md. CLAUDE.md ("Admonitions") lists only note, tip, warning, and danger; the style guide adds "Use Tip for actions, Note or Info for information, Warning for data loss or security risks, Danger for pipeline outages". caution is also a deprecated Docusaurus alias, and these two are the only uses of it anywhere in docs/.

Since silently changed hash output can break downstream joins, warning is the right type — for example :::warning[Hash output changes in version 6.0.0].

2. New admonitions are missing bracket titles

:::note
Version 6.0.0 makes breaking changes to the HTTP target's OAuth2 configuration.

Style guide, Markdown formatting: "Always set custom headings using bracket syntax: :::note[Title]." This applies to all three new admonitions in targets/http/index.md plus the two caution blocks. The neighboring 4.0.0/5.0.0 notes are untitled too, so this is inherited — but it matters most for the caution in custom-scripts/index.md, which sits between the hash and allContexts bullets. Without a title it reads as applying to the whole Helper functions section rather than to hash alone. A title such as :::warning[hash output changes in version 6.0.0] fixes the scoping.

3. Missing Oxford comma

"Configure the oauth_client {} block with client_id, client_secret and refresh_token"

CLAUDE.md, Grammar and formatting: "Use the Oxford comma". Fix: client_id, client_secret, and refresh_token.

4. Bolded full sentences in the upgrade guide

**Migration required if you depend on hash values matching data produced by earlier versions.**

and

**No configuration change is required, but the output values change**:

CLAUDE.md restricts bold to UI elements, and the style guide says "Never bold entire paragraphs". The 4.x and 5.x guides use a short bold label followed by unbolded prose (**Migration required**: consolidate your transformation blocks into one.). Match that:

  • **Migration required** if you depend on hash values matching data produced by earlier versions. Values hashed by...
  • **Output values change**, but no configuration change is required:

5. Table cell capitalization

| issuer | yes | Issuer claim (iss) ... |
| key | one of key/key_file | ... |

Style guide, Tables: "Capitalize the first word of cell text. Exception: code should use appropriate case." So Yes / No in the Required column, and "One of key or key_file", which also reads better than the slash.

6. "now" in a heading

### Docker images are now distroless

Style guide, Writing style: "Stay in the present tense. Never use 'currently', 'now'...". The existing upgrade guides do use "now" in body prose to mark a version change, so the body sentences ("Output length now follows...", "The Go module path is now...") are defensible, but the heading should be timeless: ### Distroless Docker images.

7. Minor

  • Future tense — "where no value is provided, this function will perform an unsalted hash of the input" (custom-scripts/index.md). Use the present tense: "performs an unsalted hash of the input".
  • Heading with no prose## Version 6.0.0 breaking changes is followed immediately by ### HTTP target OAuth2 configuration. CLAUDE.md: "Precede every heading with at least one paragraph of explanatory text." The 5.x guide has the same gap, so this is a convention thing rather than a regression, but one sentence summarizing the breaking changes would help readers scan.
  • No newline at end of file_jqHelpers.md still ends without a trailing newline after the added ::: block.

Frontmatter on the new guide matches the 5.x guide exactly (id, title, sidebar_label, date, sidebar_position, description, keywords) — no issues there. Internal links all resolve, and both external URLs touched by this PR return 200.

- Replace the non-approved :::caution admonitions with titled :::warning
- Add bracket titles to the admonitions added by this PR
- Add the missing Oxford comma in the client credentials prose
- Reduce bold to a short label rather than whole sentences, matching
  the 4.x and 5.x upgrade guides
- Capitalize table cell text in the oauth_jwt settings table
- Drop "now" from the distroless heading and from body prose
- Use the present tense for the hash helper description
- Add intro prose under the breaking changes heading
- Add the missing trailing newline to _jqHelpers.md
```

:::warning[hash output changes in version 6.0.0]
Version 6.0.0 changes the values this function returns. Before 6.0.0 it returned a PBKDF2-derived key rather than the digest, so hashes produced by 6.x do not match those produced by earlier versions for the same input. See the [6.x upgrade guide](/docs/api-reference/snowbridge/upgrade-guides/upgrade-guide-6-X-X/index.md) for details.

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.

Did we have anyone using this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

JQ transformation - yes . JQ with hash - no idea!

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.

2 participants