Skip to content

Modernize GitHub links pinned to commit SHAs - #5012

Draft
Duncanma wants to merge 1 commit into
mainfrom
duncan/github-links-commit-shas-f5b04a
Draft

Modernize GitHub links pinned to commit SHAs#5012
Duncanma wants to merge 1 commit into
mainfrom
duncan/github-links-commit-shas-f5b04a

Conversation

@Duncanma

@Duncanma Duncanma commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to an earlier GitHub link sweep that intentionally skipped ~40 links pinned to commit SHAs, since many carry line anchors (#L108) that drift and would silently point at the wrong line if just moved to main.

  • Links without a line anchor (20): repointed to the repo's default branch (main, or master for grpc/grpc). Two of these had moved to a new path along the way, so the link target was updated accordingly:
    • cloud-samples-go's client/api/apikey.go was merged into client/api/client.go.
    • ui's server/docker/config-template.yaml moved to server/config/docker.yaml.
  • Links with a line anchor (20): fetched the original pinned snapshot to identify exactly what each anchor pointed at, located that same declaration in the current default-branch HEAD, and re-pinned to today's commit SHA with the corrected line number. Several had moved files entirely, e.g. temporal's history size/count limit defaults moved from service/history/configs/config.go into common/dynamicconfig/constants.go, and common/metrics/defs.gometric_defs.go.

One item is flagged rather than fixed: limits.mdx links to MaxCHASMCallbacksPerWorkflow, a dynamic config key that has been removed entirely from temporalio/temporal (it was marked temporary pending CHASM's rollout). Left a TODO comment for whoever owns that content to decide whether to drop the bullet or replace it.

Test plan

  • Verified every re-pinned line by diffing the old pinned snapshot against the new HEAD content for each file
  • vale --config .vale-ci.ini docs/ on all touched files — 0 errors/warnings (pre-existing heading-style suggestions only, unrelated to this change)
  • Confirmed no remaining commit-SHA-pinned links in docs/ outside the one flagged item

┆Attachments: EDU-6866 Modernize GitHub links pinned to commit SHAs

Unpin links without line anchors to the repo's default branch (main/master),
fixing two that had moved to new paths along the way. Re-verify and re-pin
links with line anchors to the current default-branch commit, correcting
line numbers where the referenced code has moved.
@vercel

vercel Bot commented Aug 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Error Error Aug 1, 2026 12:07am

Request Review

[Cloud Samples in Go](https://github.com/temporalio/cloud-samples-go/blob/1dd4254b6ed1937e361005c0144410e72b8a5542/client/api/apikey.go).
[Cloud Samples in Go](https://github.com/temporalio/cloud-samples-go/blob/main/client/api/client.go).

### Terraform Provider

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.

📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Terraform Provider' should use sentence-style capitalization.

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

❌ Docs build failed

We couldn't automatically identify the specific error from the build output. Here are the last 60 lines of the build log:

Build log tail
yarn run v1.22.22
$ node ./bin/sync-ai-cookbook.js
[sync-ai-cookbook] cloning https://github.com/temporalio/ai-cookbook.git (main)
Cloning into '/tmp/ai-cookbook-sync/repo'...
[sync-ai-cookbook] skipped README.md: missing front matter comment
[sync-ai-cookbook] skipped agents/agentic_loop_tool_call_openai_python/tools/README.md: missing front matter comment
[sync-ai-cookbook] skipped agents/agentic_loop_tool_call_claude_python/tools/README.md: missing front matter comment
[sync-ai-cookbook] wrote 13 file(s):
  - agentic-loop-tool-call-claude-python.mdx ← agents/agentic_loop_tool_call_claude_python/README.md
  - agentic-loop-tool-call-openai-python.mdx ← agents/agentic_loop_tool_call_openai_python/README.md
  - basic-openai-python.mdx ← deep_research/basic_openai_python/README.md
  - claim-check-pattern-python.mdx ← foundations/claim_check_pattern_python/README.md
  - hello-world-durable-mcp-server.mdx ← mcp/hello_world_durable_mcp_server/README.md
  - hello-world-litellm-python.mdx ← foundations/hello_world_litellm_python/README.md
  - hello-world-openai-responses-python.mdx ← foundations/hello_world_openai_responses_python/README.md
  - http-retry-enhancement-python.mdx ← foundations/http_retry_enhancement_python/README.md
  - human-in-the-loop-python.mdx ← agents/human_in_the_loop_python/README.md
  - openai-agents-sdk-python.mdx ← agents/openai_agents_sdk_python/README.md
  - strands-agents-python.mdx ← agents/strands_agents_python/README.md
  - structured-output-openai-responses-python.mdx ← foundations/structured_output_openai_responses_python/README.md
  - tool-call-openai-python.mdx ← agents/tool_call_openai_python/README.md
$ node --max-old-space-size=7168 ./node_modules/@docusaurus/core/bin/docusaurus.mjs build
[INFO] [en] Creating an optimized production build...
[cookbook-index] init with docsDir: ai-cookbook
[cookbook-index] resolved docsDir: /home/runner/work/documentation/documentation/ai-cookbook
[ERROR] Client bundle compiled with errors therefore further build is impossible.
╰─▶   × Error: MDX compilation failed for file "/home/runner/work/documentation/documentation/docs/encyclopedia/workflow/workflow-execution/limits.mdx"
        │ Cause: Unexpected lazy line in expression in container, expected line to be prefixed with `>` when in a block quote, whitespace when in a list, etc
        │ Details:
        │ {
        │   "column": 1,
        │   "file": "",
        │   "message": "Unexpected lazy line in expression in container, expected line to be prefixed with `>` when in a block quote, whitespace when in a list, etc",
        │   "line": 51,
        │   "name": "51:1",
        │   "place": {
        │     "_bufferIndex": 0,
        │     "_index": 4,
        │     "line": 51,
        │     "column": 1,
        │     "offset": 2977
        │   },
        │   "reason": "Unexpected lazy line in expression in container, expected line to be prefixed with `>` when in a block quote, whitespace when in a list, etc",
        │   "ruleId": "unexpected-lazy",
        │   "source": "micromark-extension-mdx-expression",
        │   "url": "https://github.com/micromark/micromark-extension-mdx-expression/tree/main/packages/micromark-extension-mdx-expression#unexpected-lazy-line-in-expression-in-container-expected-line-to-be-prefixed"
        │ }
        │
        │     at compileToJSX (/home/runner/work/documentation/documentation/node_modules/@docusaurus/mdx-loader/lib/utils.js:93:15)
        │     at async loadMDX (/home/runner/work/documentation/documentation/node_modules/@docusaurus/mdx-loader/lib/loader.js:22:20)
        │     at async Object.mdxLoader (/home/runner/work/documentation/documentation/node_modules/@docusaurus/mdx-loader/lib/loader.js:157:24)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Run yarn build locally to reproduce the full error.

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

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