[GithubReleaseBranch] Add GitHub release by branch badge#11941
Draft
LuxologyGG wants to merge 4 commits into
Draft
[GithubReleaseBranch] Add GitHub release by branch badge#11941LuxologyGG wants to merge 4 commits into
LuxologyGG wants to merge 4 commits into
Conversation
Contributor
|
cursor
Bot
force-pushed
the
feat/auto-badge-issue-7929
branch
from
7494ccb to
a5761af
Compare
LuxologyGG
changed the title
Implements a version badge that shows the latest release for a specified branch using the GitHub releases API target_commitish field. Closes badges#7929
Reorder static render before transform and fix Prettier formatting in spec and tester files.
LuxologyGG
force-pushed
the
feat/auto-badge-issue-7929
branch
from
ddd13e4 to
eedd3b2
Compare
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
2 participants
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.
Closes #7929
Summary
Adds a new version badge that shows the latest GitHub release for a specified branch. The badge matches releases using the
target_commitishfield from the GitHub releases API and paginates through release pages when needed.Example
Produces a badge labeled
latest-release@13.xwith the latest release version for that branch.API rate limits
This badge uses the GitHub REST API (
GET /repos/{owner}/{repo}/releases). Unauthenticated requests are limited to 60 requests/hour per IP; authenticated requests allow 5,000 requests/hour per token. Shields.io uses configured GitHub tokens when available.Checklist
services/github/github-release-branch.service.js)services/github/github-release-branch.service.spec.js)services/github/github-release-branch.tester.js)npm run lint(0 errors)Testing
npm run test:core -- --grep GithubReleaseBranch(9 passing)npm run test:services -- --only=GithubReleaseBranch(10 passing)