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

Don't use outside images in docs examples #1416

Merged
merged 9 commits into from
Sep 28, 2022
Merged

Don't use outside images in docs examples #1416

merged 9 commits into from
Sep 28, 2022

Conversation

jonrohan
Copy link
Member

@jonrohan jonrohan commented Sep 27, 2022

I believe some of our axe-core timeouts are because some of our docs examples contain images from outside servers. My theory is that the tests are loaded in headless chrome and the urls are then requested, which sometimes they don't resolve.

This PR solves this in 2 ways:

  • Instead of image urls in the docs, im using a base64 encoded string of the octocat.
  • I'm also installing webmock to disable any outgoing requests in the tests.

@changeset-bot
Copy link

changeset-bot bot commented Sep 27, 2022

🦋 Changeset detected

Latest commit: a513b72

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@jonrohan jonrohan temporarily deployed to review-pr-1416 September 27, 2022 17:58 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 27, 2022 18:02 Inactive
@jonrohan jonrohan temporarily deployed to review-pr-1416 September 27, 2022 18:20 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 27, 2022 18:23 Inactive
@jonrohan jonrohan temporarily deployed to review-pr-1416 September 27, 2022 18:33 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 27, 2022 18:39 Inactive
@jonrohan jonrohan temporarily deployed to review-pr-1416 September 27, 2022 19:27 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 27, 2022 19:32 Inactive
@jonrohan jonrohan marked this pull request as ready for review September 27, 2022 19:38
@jonrohan jonrohan requested review from a team, keithamus and camertron and removed request for keithamus September 27, 2022 19:38
@jonrohan jonrohan enabled auto-merge (squash) September 27, 2022 21:00
@jonrohan jonrohan temporarily deployed to review-pr-1416 September 28, 2022 00:57 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 28, 2022 01:03 Inactive
@jonrohan jonrohan temporarily deployed to review-pr-1416 September 28, 2022 17:25 Inactive
@jonrohan jonrohan temporarily deployed to github-pages September 28, 2022 17:30 Inactive
@jonrohan jonrohan merged commit f99156f into main Sep 28, 2022
@jonrohan jonrohan deleted the docs_image_src branch September 28, 2022 19:36
@primer-css primer-css mentioned this pull request Sep 28, 2022
jonrohan added a commit that referenced this pull request Sep 30, 2022
* Don't use outside images

* move things

* Urls here is fine

* Disable for now

* Installing webmock to disable outside calls in tests

* allow localhost
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.

2 participants