Skip to content

ci: run docs CI on python and typescript changes - #3178

Merged
zastrowm merged 1 commit into
strands-agents:mainfrom
zastrowm:runk-docs-ci
Jul 10, 2026
Merged

ci: run docs CI on python and typescript changes#3178
zastrowm merged 1 commit into
strands-agents:mainfrom
zastrowm:runk-docs-ci

Conversation

@zastrowm

Copy link
Copy Markdown
Member

Description

The docs site build typechecks documentation code snippets against the freshly-built SDK types, so an SDK change (e.g. renaming or removing a public member) can break it. The docs job previously ran only on site/** changes, letting these breakages slip through SDK-only PRs. This also gates it on python/typescript changes so they're caught at PR time.

Related Issues

Documentation PR

No documentation changes required.

Type of Change

Other: CI configuration change

Testing

CI-only change. Verified the workflow condition and confirmed ci-gate still permits docs as a skip.

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have reviewed and understand every line of code in this PR, including any generated by AI tools, and I can explain why it works
  • My change is focused and reasonably small; I have split unrelated work into separate PRs
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions Bot added size/xs chore Maintenance tasks, dependency updates, CI changes, refactoring with no user-facing impact area-community Related to community and contributor health labels Jul 10, 2026
@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@zastrowm
zastrowm marked this pull request as ready for review July 10, 2026 15:11
@zastrowm
zastrowm requested a review from a team as a code owner July 10, 2026 15:11
@zastrowm
zastrowm requested a review from notowen333 July 10, 2026 15:11
@zastrowm
zastrowm enabled auto-merge (squash) July 10, 2026 15:13
Comment thread .github/workflows/ci.yml
@github-actions

Copy link
Copy Markdown
Contributor

Assessment: Comment (approve-leaning)

Small, well-reasoned CI change. I verified the premise: docs-ci.yml builds the TypeScript SDK and typechecks doc snippets against it, so gating docs on typescript changes genuinely closes the gap where SDK-only PRs could break the docs build. ci-gate still lists docs in allowed-skips, so non-SDK/non-site PRs correctly skip it.

Review notes
  • Correctness: The added || conditions are correct; detect-changes outputs are all valid and the skip behavior is preserved.
  • Scope/asymmetry: The python trigger provides weaker protection than typescript since there is no Python snippet typecheck in docs-ci.yml — see the inline comment. Worth confirming this is a deliberate tradeoff vs. added CI time on every Python PR.
  • Tests/docs: N/A for a CI config change.

Nice catch on a real coverage gap — this is a sensible hardening of the merge gate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-community Related to community and contributor health chore Maintenance tasks, dependency updates, CI changes, refactoring with no user-facing impact size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants