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: check external links (excluding GH) #2362

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Feb 18, 2023

  • This is a first attempt at enabling full link checking, both internal paths and external links. Let's give this a test run. It might be an issue for PRs adding lots of new content with many new external references.
    Note: Adding external link checking, with the cache, takes at most 2 sec more on my local machine.
  • Contributes to CI: check external links #1052
  • Repurposed the check:links NPM script for full link checking
  • Runs Prettier over static
  • Saves the htmltest refcache.json file under static so that it gets deployed. That way each "edition" of the website will have it's own published refcache data file.
  • Normalizes a few external links in the docs

Note: If / once this PR is merged, anyone submitting a PR will need to run npm run test (as indicated in the contributing notes) to update the refcache. We're not currently filing if that isn't done, but we might soon.

/cc @reyang

@chalin chalin added CI/infra CI & infrastructure cleanup/refactoring labels Feb 18, 2023
@chalin chalin requested review from a team February 18, 2023 20:00
@chalin chalin force-pushed the chalin-im-ext-link-checking-take-1-2023-02-18 branch 2 times, most recently from 99eca67 to 9c1aaad Compare February 18, 2023 20:10
@chalin chalin mentioned this pull request Feb 18, 2023
15 tasks
@chalin
Copy link
Contributor Author

chalin commented Feb 18, 2023

Links checked (internal and external) in less than 8 seconds. From the build log:

> npm run _check:links
...
htmltest started at 08:10:56 on public
--
| ========================================================================
| ✔✔✔ passed in 7.515506054s
| tested 333 documents

implemented OpenTelemetry in their organizations, resolved common issues, and
more. Example topics that have been discussed include tail sampling, collector
scaling, and OpAMP; there really is no limit to the topics! We simply ask that
you be respectful and abide by the [Chatham House Rule](https://www.chathamhouse.org/about-us/chatham-house-rule#:~:text=The%20Rule%20reads%20as%20follows,other%20participant%2C%20may%20be%20revealed.).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI, I dropped the higlight "hash" from the link.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably best to review the changes to this file while ignoring whitespace differences.

@chalin
Copy link
Contributor Author

chalin commented Feb 18, 2023

/cc @trask

@chalin chalin force-pushed the chalin-im-ext-link-checking-take-1-2023-02-18 branch from 9c1aaad to 35bfff1 Compare February 18, 2023 22:17
@chalin chalin removed the request for review from a team February 18, 2023 22:17
@chalin chalin merged commit c9f3f76 into open-telemetry:main Feb 19, 2023
@chalin chalin deleted the chalin-im-ext-link-checking-take-1-2023-02-18 branch February 19, 2023 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants