Repository navigation
Allowed hosted images, such as the Exchange badge, in the README check - #1
Merged
Merged
Conversation
The check that each README image is a file in the repo failed on the CyberAgents Exchange badge, which is hosted on shields.io. Hosted images still need alt text, but aren't looked for in the repo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CI started failing after the CyberAgents Exchange badge was added to the README. The docs test checks that every image in the README has alt text and is a file in the repo, and the badge is hosted on shields.io, so the test looked for a local file named after its URL.
The test now skips the file check for images that are web addresses. Every image still needs alt text, and the README still needs at least one screenshot from the repo.
Testing: pytest tests/test_docs.py: 43 passed; without the change, the README case fails, as in CI. ruff check . passes.