This repository has been archived by the owner on Dec 15, 2022. It is now read-only.
Use latest tag for image source URL in the readme #1032
Conversation
This file contains 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
jerthiry
changed the title
|
Not quite sure how to write specs for this. For now, it tests that the URL of the relative image in the README is https://github.com/example/package-with-readme/blob/master/static/image.jpg. With this fix it would be something like https://github.com/example/package-with-readme/raw/v1.0.0/static/image.jpg, but it checks the latest tag online and there is of course none for this toy example. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description of the Change
The source for the images of the README of uninstalled packages are now taken from the latest tag instead of defaulting to repo/blob/master. This default behavior caused some images to not appear.
Before
After
Alternate Designs
It is also possible to fall back on the latest release but some repositories have tags and no release.
Benefits
Some repo do not have a master branch or the README has changed since the latest tag (no more images or filenames have changed), causing the images to not appear. Here it is not the case anymore.
Possible Drawbacks
Maybe the latest tag will be in advance compared to the available version on the package.
Applicable Issues
READMEs should fall back to latest tag, not master #1012
The issue is also referenced in #996