Skip to content

Test breaking docs semantically on CI#27075

Closed
findepi wants to merge 2 commits into
trinodb:masterfrom
findepi:findepi/break-docs-v2
Closed

Test breaking docs semantically on CI#27075
findepi wants to merge 2 commits into
trinodb:masterfrom
findepi:findepi/break-docs-v2

Conversation

@findepi
Copy link
Copy Markdown
Member

@findepi findepi commented Oct 23, 2025

Summary by Sourcery

Test breaking documentation semantically in the CI pipeline by updating the user-mapping.json file

CI:

  • Add semantic validation check for Sphinx docs in CI

Documentation:

  • Modify user-mapping.json to introduce a semantic break in documentation

@cla-bot cla-bot Bot added the cla-signed label Oct 23, 2025
@sourcery-ai

This comment was marked as duplicate.

@findepi findepi marked this pull request as draft October 23, 2025 15:02
@github-actions github-actions Bot added the docs label Oct 23, 2025
sourcery-ai[bot]

This comment was marked as duplicate.

@findepi
Copy link
Copy Markdown
Member Author

findepi commented Oct 23, 2025

when docs are semantically broken it may be caught up by eg TestUserMapping.testDocsExample
test-docs (:trino-main) failed as expected ✅

@findepi
Copy link
Copy Markdown
Member Author

findepi commented Oct 23, 2025

when docs are semantically broken, and there also is some other code change, the regression may not be caught by CI ❌

@findepi
Copy link
Copy Markdown
Member Author

findepi commented Oct 23, 2025

@findepi findepi closed this Oct 23, 2025
@findepi findepi deleted the findepi/break-docs-v2 branch October 23, 2025 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

1 participant