Skip to content

ci: run documentation tests weekly - #6920

Merged
pichlermarc merged 4 commits into
open-telemetry:mainfrom
LarryHu0217:codex/docs-test-weekly-6766
Aug 19, 2026
Merged

ci: run documentation tests weekly#6920
pichlermarc merged 4 commits into
open-telemetry:mainfrom
LarryHu0217:codex/docs-test-weekly-6766

Conversation

@LarryHu0217

Copy link
Copy Markdown
Contributor

Which problem is this PR solving?

The documentation link check depends on external sites and can fail pull-request lint during temporary outages. This moves that check to a weekly scheduled workflow while keeping a manual trigger available.

Fixes #6766

Short description of the changes

  • Remove documentation generation and link checking from the pull-request lint workflow.
  • Add a weekly workflow that compiles the repository, generates API documentation, and checks documentation links.
  • Allow maintainers to run the documentation workflow manually.

Changelog is not applicable because this only changes CI scheduling.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Parsed both workflow files as YAML.
  • Ran Prettier checks on both workflow files.
  • Ran npm ci --ignore-scripts and npm run compile.
  • Ran NODE_OPTIONS=--max-old-space-size=6144 npm run docs.
  • Ran npm run docs:test; 55 generated-documentation links and 38 repository-documentation links passed.

Checklist

  • Followed the style guidelines of this project
  • Unit tests have been added (not applicable for a workflow-only change)
  • Documentation has been updated (not applicable; no user-facing behavior changes)

@LarryHu0217
LarryHu0217 requested a review from a team as a code owner July 15, 2026 17:31
@codecov

codecov Bot commented Jul 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.02%. Comparing base (bdccd1f) to head (44c8f6a).
⚠️ Report is 16 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6920   +/-   ##
=======================================
  Coverage   95.02%   95.02%           
=======================================
  Files         409      409           
  Lines       14301    14301           
  Branches     3277     3277           
=======================================
  Hits        13590    13590           
  Misses        711      711           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@LarryHu0217

Copy link
Copy Markdown
Contributor Author

This PR only changes CI scheduling, which CONTRIBUTING.md lists as a case where a changelog entry may be omitted. The changelog check is failing because the PR does not have the Skip Changelog label, and contributors cannot apply repository labels. Could a maintainer please add Skip Changelog?

@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Jul 18, 2026

Copy link
Copy Markdown

Pull request dashboard status

Merged · refreshed 2026-08-19 18:51 UTC

Status above doesn't look right?
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

@LarryHu0217

Copy link
Copy Markdown
Contributor Author

@open-telemetry/javascript-approvers This PR has not had reviewer interaction for over a week and is ready for review. All checks except the changelog check pass. CONTRIBUTING.md says CI/CD updates may omit a changelog entry and use the Skip Changelog label. Could an approver add that label if appropriate, or let me know if you would prefer a changelog entry?

@LarryHu0217
LarryHu0217 requested a review from a team as a code owner August 2, 2026 14:19
@LarryHu0217

LarryHu0217 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

The only remaining required-check failure is node-windows-tests: the existing experimental/packages/configuration/test/types.test.ts compile fixture test exceeded its 10-second Mocha timeout after the other 134 tests passed. This PR only changes the documentation-test workflow schedule, and all other jobs are green. I also tried to rerun the failed job, but the upstream run cannot be rerun from my contributor account. Could a maintainer please rerun that job? No source change appears warranted for this PR.

@LarryHu0217

Copy link
Copy Markdown
Contributor Author

/dashboard route:reviewers

@opentelemetry-pr-dashboard

Copy link
Copy Markdown

@LarryHu0217 routed this pull request to reviewers.

@LarryHu0217
LarryHu0217 force-pushed the codex/docs-test-weekly-6766 branch from f9acb99 to 0e1a029 Compare August 9, 2026 21:12
@pichlermarc
pichlermarc self-requested a review August 19, 2026 16:26

@pichlermarc pichlermarc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks!

@pichlermarc
pichlermarc added this pull request to the merge queue Aug 19, 2026
Merged via the queue into open-telemetry:main with commit 756f49a Aug 19, 2026
34 of 36 checks passed
@otelbot

otelbot Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution @LarryHu0217! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

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.

docs:test is flaky

2 participants