Skip to content

docs(error-tracking): link releases for python, ruby, and php - #20390

Merged
ablaszkiewicz merged 5 commits into
masterfrom
docs/error-tracking-server-release-ids
Sep 24, 2026
Merged

ablaszkiewicz merged 5 commits into
masterfrom
docs/error-tracking-server-release-ids

Conversation

@ablaszkiewicz

@ablaszkiewicz ablaszkiewicz commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Changes

Python, Ruby, and PHP users have no docs page that tells them how to link their exceptions to a release. These languages have no source maps, so the upload guides do not apply to them.

  • New pages: Python, Ruby, and PHP under "Upload source maps".
  • Each page tells the user to resolve the release only in the production deploy, because resolving creates a release.
  • The default path is the PostHog/resolve-release GitHub Action. Its release-id output goes into the app as POSTHOG_RELEASE_ID, for example as a Docker build argument.
  • A "Without GitHub Actions" section shows the same flow with posthog-cli release resolve in four commands.
  • The three pages share four snippets. Only the SDK version step and the PHP-FPM note differ.
  • The sidebar nav and the platform grid on the overview page get Python, Ruby, and PHP entries.
  • releases.mdx and the overview page get one line each that point to the new pages.

Warning

The Ruby and PHP SDK changes are not released yet (posthog-ruby#277, posthog-php#247). The pages name posthog-ruby 3.25.0 and posthog-php 4.14.0, the next minor versions. Keep this PR in draft until both ship, then confirm the version numbers and links.

Python support shipped in posthog-python 7.59.0.

Nav

Before After
Light before-nav-light-wide after-nav-light-wide
Dark before-nav-dark-wide after-nav-dark-wide

Checked on the preview

  • The pages render on the preview: Python in light and dark at 640 and 1440 px, PHP in dark at 1440 px, Ruby and the overview grid in light at 1440 px.
  • The console errors on the new pages (an SVG width="auto" warning and React errors Burger menu color fix #418 and Small fixes for pricing and free trial pages #423) also appear on the existing Go and CLI pages.
  • Not checked on a local dev server: pnpm start fails on this machine with an SSR error in src/components/AI/TerminalPersonas.tsx, which this PR does not touch.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json (no page moved)

🤖 Agent context

Written with Claude Code (Claude Opus 5.5), directed by the PR author. The content comes from the public PostHog/resolve-release README, the posthog-cli README, and the public SDK PRs linked above.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the docs Improvements or additions to product documentation, "Docs" label Sep 23, 2026
@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Sep 24, 2026 01:42PM

Changed pages

Page Source
PHP Error Tracking installation contents/docs/error-tracking/installation/php.mdx
Link releases contents/docs/error-tracking/link-releases/index.mdx
Link releases for PHP contents/docs/error-tracking/link-releases/php.mdx
Link releases for Python contents/docs/error-tracking/link-releases/python.mdx
Link releases for Ruby contents/docs/error-tracking/link-releases/ruby.mdx
Releases contents/docs/error-tracking/releases.mdx
Upload source maps contents/docs/error-tracking/upload-source-maps/index.mdx

@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Vale prose linter → found 0 errors, 21 warnings, 0 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/error-tracking/installation/php.mdx — 0 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'PHP' instead of 'php'. Vale.Terms
152:53 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
154:59 warning 'Throwable' is a possible misspelling. PostHogBase.Spelling
contents/docs/error-tracking/link-releases/_snippets/release-id-github-actions.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
40:47 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
contents/docs/error-tracking/link-releases/_snippets/release-id-verify.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
1:70 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames
contents/docs/error-tracking/link-releases/php.mdx — 0 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
3:15 warning Use 'PHP' instead of 'php'. Vale.Terms
21:10 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
21:18 warning Use 'PHP' instead of 'php'. Vale.Terms
contents/docs/error-tracking/link-releases/python.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
21:10 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
contents/docs/error-tracking/link-releases/ruby.mdx — 0 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
21:12 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
contents/docs/error-tracking/releases.mdx — 0 errors, 11 warnings, 0 suggestions
Line Severity Message Rule
7:57 warning Use American English. Use 'artifacts' instead of 'artefacts'. PostHogBase.AmericanEnglish
7:174 warning 'sourcemaps' is a possible misspelling. PostHogBase.Spelling
9:1 warning Capitalize 'Error Tracking' for PostHog's product. Use 'Error tracking' for the general industry concept. PostHogBase.ProductNames
20:63 warning 'sourcemaps' is a possible misspelling. PostHogBase.Spelling
22:111 warning 'sourcemap' is a possible misspelling. PostHogBase.Spelling
22:504 warning Use American English. Use 'artifacts' instead of 'Artefacts'. PostHogBase.AmericanEnglish
26:14 warning Use American English. Use 'artifacts' instead of 'artefacts'. PostHogBase.AmericanEnglish
28:18 warning 'sourcemaps' is a possible misspelling. PostHogBase.Spelling
28:114 warning Use American English. Use 'artifacts' instead of 'artefacts'. PostHogBase.AmericanEnglish
30:4 warning 'Release context in error tracking' heading should be in sentence case, and product names should be capitalized. PostHogBase.SentenceCase
30:23 warning Capitalize 'Error Tracking' for PostHog's product. Use 'error tracking' for the general industry concept. PostHogBase.ProductNames

@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Bundle report

Total JS (gzip)

8.67 MiB (+2.1 KiB / +0.0%)

Largest changed named chunks
Chunk Gzip Δ vs master
app.js 2328.5 KiB +2.1 KiB / +0.1%

Eager graph (modules shipped in each entrypoint's initial chunks)

Entrypoint Eager size Budget Modules
✅ app 18.68 MiB (+11.7 KiB / +0.1%) report-only 2074
Largest modules in the app closure
Module Size
./src/data/mcp-tools.json 1195.2 KiB
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css 772.5 KiB
./src/components/Stickers/Stickers.tsx 696.4 KiB
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js 481.4 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/x-ray.mjs 480.8 KiB
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules 395.1 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/im-the-driver.mjs 385.7 KiB
./src/hooks/useCustomers.tsx + 55 modules 372.9 KiB
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js 354.8 KiB
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules 351.4 KiB
./src/components/ProductComparisonTable/index.tsx + 127 modules 310.3 KiB
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js 281.9 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/doll-house.mjs 281.7 KiB
./node_modules/.pnpm/@posthog+brand@0.8.0_react@18.3.1/node_modules/@posthog/brand/dist/generated/hoggies/svg/director.mjs 275.6 KiB
./src/components/SearchUI/index.tsx + 87 modules 273.7 KiB

Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes for the modules actually shipped in the entrypoint's initial chunks (post-tree-shake).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ablaszkiewicz
ablaszkiewicz marked this pull request as ready for review September 24, 2026 13:03
@ablaszkiewicz

ablaszkiewicz commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor Author

@hpouillot I wasn't entirely sure where to put it. Decided to put it in "upload source maps" because it made the most sense to me (because this is an optional step and it is an infra change. Much like source maps setup).

You can preview these docs here:

Next I'm going to work on the wizard so it does this automatically 🤓

@hpouillot

hpouillot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

I am wondering if we should not create a new category for the release binding. Also It seems a bit odd to show docker instructions directly for PHP. I think it's fine to just say we need this ENV variable and it's up to the user to expose it. They should know how to do it if they use docker and if they don't, they will probably use the wizard anyway ?

@ablaszkiewicz

Copy link
Copy Markdown
Contributor Author

@hpouillot main knowledge engine for our wizard is the docs so I really wanted to explain all the options in the docs. This way wizard will be just plug-and-play without embedding technology-specific knowledge in our custom wizard skills

Python, Ruby, and PHP have no source maps, so their release guides move
out of "Upload source maps" into a new "Link releases" section with an
overview page.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@hpouillot

Copy link
Copy Markdown
Contributor

The docker section is duplicated across php, ruby and python. I am not sure the agent will get more info from it but up to you.

ablaszkiewicz and others added 2 commits September 24, 2026 15:22
…leases

The installation guides for these languages now end with an optional
"Link releases" step, where the JavaScript guides end with "Upload
source maps".

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The guides now say only that the deployed app needs POSTHOG_RELEASE_ID
in its environment. How to pass it depends on the user's deploy setup.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ablaszkiewicz
ablaszkiewicz merged commit f5b45a2 into master Sep 24, 2026
22 checks passed
@ablaszkiewicz
ablaszkiewicz deleted the docs/error-tracking-server-release-ids branch September 24, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to product documentation, "Docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants