Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] Handle missing tocstop tag in spec pages #6056

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jan 23, 2025

  • Reports a warning if a spec page is missing a tocstop directive, and gracefully recovers
  • For example, the script now reports issues like [docs] incomplete <-- toc --> directive semantic-conventions#1799:
    WARN tmp/semconv/docs/exceptions/exceptions-spans.md:14: missing '<!-- tocstop -->' directive? Aborting toc scan at line:
      14: ## Exception event
    

/cc @trask

Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

RSLGTM.

@chalin chalin added this pull request to the merge queue Jan 23, 2025
Merged via the queue into open-telemetry:main with commit ffb15e0 Jan 23, 2025
17 checks passed
@chalin chalin deleted the chalin-im-specs-handle-missing-tocstop-tag-2025-01-23 branch January 23, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants