Prefer ENV["HORO_BADGE_VERSION"] version in banner
#270
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
Prior to this commit, the banner at the top of each page would display the value of `ENV["HORO_PROJECT_VERSION"]`. For Rails, this would either be a bare number, e.g. "7.0.0" without a "v" prefix, or a commit reference, e.g. `main@1234567`. In contrast, the value of `ENV["HORO_BADGE_VERSION"]` is intended to be more user friendly. For Rails, it would be e.g. "v7.0.0" or "edge". This commit changes the banner to display `ENV["HORO_BADGE_VERSION"]` if it is set, and otherwise fall back to `ENV["HORO_PROJECT_VERSION"]`. However, since it may still be valuable for maintainers to know the exact commit that the documentation was generated from, this commit also adds a tooltip to show the abbreviated SHA1 of the commit when hovering over the version.
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.
Prior to this commit, the banner at the top of each page would display the value of
ENV["HORO_PROJECT_VERSION"]. For Rails, this would either be a bare number, e.g. "7.0.0" without a "v" prefix, or a commit reference, e.g.main@1234567.In contrast, the value of
ENV["HORO_BADGE_VERSION"]is intended to be more user friendly. For Rails, it would be e.g. "v7.0.0" or "edge".This commit changes the banner to display
ENV["HORO_BADGE_VERSION"]if it is set, and otherwise fall back toENV["HORO_PROJECT_VERSION"]. However, since it may still be valuable for maintainers to know the exact commit that the documentation was generated from, this commit also adds a tooltip to show the abbreviated SHA1 of the commit when hovering over the version.