add sort and prerelease query params to [GitHubCommitsSince] (also refactors [GitHubRelease], [GitHubTag]) #4395

agilgur5 · 2019-12-04T05:47:28Z

Description

Uses the new query params logic from the GitHubRelease Service to provide the same functionality for the GitHubCommitsSince Service when using the latest release (so one can use e.g. latest.json?sort=semver).

Motivation

I have some libraries where I have a commits since badge meant to track number of commits since the "latest" release. Since "latest" by GitHub API is by date, this means if I release a backport, the badge will start tracking from that backport since it's latest by date. Tracking commits since latest by semver is what I would like to do.

The workaround I've been having to do without this is to put the latest SemVer version into the badge and updating it whenever I make a new release (tedious, and has to already be pinned before any backport is released, otherwise above bug will occur until the badge is pinned, and if, say it's released on NPM before the badge is pinned, it will be tracking the backport until another release is added)

Related to #1955 ; upon second read, I realized that asks for the addition of tags on top of just releases, what I was looking for in #1955 (comment) is actually different -- the addition of SemVer. Guess I read that wrong when I made that comment and never filed a separate issue for SemVer support.

Review Notes

Some things to look at in particular:

I renamed github-release.spec.js to gh.l7l.us.kgmon-fetch.spec.js because I moved the logic there so it could be shared. getLatestRelease isn't normally exposed, so I exported it as _getLatestRelease so that the tests could import it. Not sure what the optimal/preferred way would be to do this (other than rewriting the tests to run against the new fetchLatestRelease).
- EDIT: I also don't know how to run gh.l7l.us.kgmon-fetch.spec.js as it itself is not a service. It's currently causing CI to error because it's not found 😕
The examples and tests for commits since. I could add more permutations of how one could combine the query params with each other and with branches, but not sure if that is necessary.

Potential Future Opportunities

In addition to latest, could extending tracking for specific SemVer line -- e.g. ^1.0.0 would track latest 1.x.x releases. This seems far from trivial (and unsure of efficiency on GitHub API), but it would allow say, a backport branch to show how many commits since the latest backport, instead of latest by SemVer or latest by date. Could also be used to track a certain SemVer line of dependencies or something

shields-ci · 2019-12-04T05:48:49Z

	Messages
📖	✨ Thanks for your contribution to Shields, @agilgur5!

Generated by 🚫 dangerJS against 4e882d3

calebcartwright · 2019-12-04T06:10:01Z

Thanks for the PR @agilgur5!

EDIT: I also don't know how to run gh.l7l.us.kgmon-fetch.spec.js as it itself is not a service. It's currently causing CI to error because it's not found 😕

That's correct, the [ServiceClassName..] notation in the PR title's are used to specify which subset of the service tests to run in the service test stage (more details here). That's utilized because the of the nature of the service tests (integration testing with the upstream platforms/APIs) and how long it takes to run the full suite.

There's other jobs that will run all of the unit tests, including those defined in gh.l7l.us.kgmon-fetch.spec.js, so those don't have to be called out explicitly in the PR title.

I've updated the PR title accordingly and everything looks green now 👍

agilgur5 · 2019-12-04T06:24:48Z

Thanks for the super-fast response @calebcartwright !! 😮

There's other jobs that will run all of the unit tests, including those defined in gh.l7l.us.kgmon-fetch.spec.js, so those don't have to be called out explicitly in the PR title.

Ah I see, gotcha. I read the service-tests docs and didn't have trouble understanding those, but I didn't know what the Jasmine tests ran under. Somehow I didn't realize they were unit tests when I was reading through (despite looking up what the sazerac package does) -- that makes a lot more sense now 😅

calebcartwright · 2019-12-04T06:38:54Z

Thanks for the super-fast response

Fortunate timing 😄

CI looks good and the review app is up at https://shields-staging-pr-4395.herokuapp.com/ if you'd like to poke around.

I'm signing out for the night but this'll get a more thorough review from a maintainer soon. Thanks again!

PyvesB · 2019-12-05T21:41:22Z

Thanks for the contribution @agilgur5! Will aim at reviewing it over the week-end if no one picks it up before. 😉

services/github/gh.l7l.us.kgmon-fetch.js

services/github/gh.l7l.us.kgmits-since.service.js

services/github/gh.l7l.us.kgmits-since.tester.js

- so that the sorting and prerelease logic can be used for other services too, like commits-since

- they only work when using the 'latest' version of course - uses same logic as release service

- as they were the exact same schema

- and the same variable everywhere

…cts [GitHubCommitsSince], [GitHubRelease], [GitHubTag]) - this logic is only used for code related to releases & tags, so made sense as a split point

calebcartwright · 2020-02-04T01:21:52Z

Thanks @agilgur5! Will try to take a final look at this one within the next couple days

calebcartwright

LGTM! Thanks again for this, apologies for the late review

shields-deployment · 2020-02-14T04:18:33Z

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

calebcartwright added the service-badge New or updated service badge label Dec 4, 2019

shields-cd temporarily deployed to shields-staging-pr-4395 December 4, 2019 06:11 Inactive

calebcartwright reviewed Dec 6, 2019

View reviewed changes

services/github/gh.l7l.us.kgmon-fetch.js Outdated Show resolved Hide resolved

calebcartwright reviewed Dec 6, 2019

View reviewed changes

services/github/gh.l7l.us.kgmits-since.service.js Outdated Show resolved Hide resolved

calebcartwright reviewed Dec 6, 2019

View reviewed changes

services/github/gh.l7l.us.kgmits-since.tester.js Show resolved Hide resolved

calebcartwright reviewed Dec 6, 2019

View reviewed changes

services/github/gh.l7l.us.kgmits-since.tester.js Outdated Show resolved Hide resolved

move getLatestRelease logic from [GitHubRelease] to common-fetch

a5e40bf

- so that the sorting and prerelease logic can be used for other services too, like commits-since

agilgur5 force-pushed the commits-since-query-params branch from 049f0ec to 02324d3 Compare December 15, 2019 22:19

agilgur5 added 3 commits December 15, 2019 17:27

add sort and prerelease query params to [GitHubCommitsSince]

bdd3c23

- they only work when using the 'latest' version of course - uses same logic as release service

reuse queryParamSchema from common-fetch for [GitHubTag]

0f7f6d2

- as they were the exact same schema

refactor [GitHubCommitsSince] tests to use withRegex

6f32ae4

- and the same variable everywhere

agilgur5 force-pushed the commits-since-query-params branch from 02324d3 to 6f32ae4 Compare December 15, 2019 22:27

split out release/tag logic from common-fetch to common-release (affe…

bbd68e7

…cts [GitHubCommitsSince], [GitHubRelease], [GitHubTag]) - this logic is only used for code related to releases & tags, so made sense as a split point

shields-cd temporarily deployed to shields-staging-pr-4395 February 5, 2020 23:44 Inactive

shields-cd temporarily deployed to shields-staging-pr-4395 February 14, 2020 01:32 Inactive

Merge branch 'master' into commits-since-query-params

4e882d3

shields-cd deployed to shields-staging-pr-4395 February 14, 2020 02:01 View deployment

calebcartwright approved these changes Feb 14, 2020

View reviewed changes

calebcartwright merged commit 7f7ecfd into badges:master Feb 14, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add sort and prerelease query params to [GitHubCommitsSince] (also refactors [GitHubRelease], [GitHubTag]) #4395

add sort and prerelease query params to [GitHubCommitsSince] (also refactors [GitHubRelease], [GitHubTag]) #4395

agilgur5 commented Dec 4, 2019 •

edited

Loading

shields-ci commented Dec 4, 2019 •

edited

Loading

calebcartwright commented Dec 4, 2019

agilgur5 commented Dec 4, 2019 •

edited

Loading

calebcartwright commented Dec 4, 2019

PyvesB commented Dec 5, 2019 •

edited

Loading

calebcartwright commented Feb 4, 2020

calebcartwright left a comment

shields-deployment bot commented Feb 14, 2020

add sort and prerelease query params to [GitHubCommitsSince] (also refactors [GitHubRelease], [GitHubTag]) #4395

add sort and prerelease query params to [GitHubCommitsSince] (also refactors [GitHubRelease], [GitHubTag]) #4395

Conversation

agilgur5 commented Dec 4, 2019 • edited Loading

Description

Motivation

Related

Review Notes

Potential Future Opportunities

shields-ci commented Dec 4, 2019 • edited Loading

calebcartwright commented Dec 4, 2019

agilgur5 commented Dec 4, 2019 • edited Loading

calebcartwright commented Dec 4, 2019

PyvesB commented Dec 5, 2019 • edited Loading

calebcartwright commented Feb 4, 2020

calebcartwright left a comment

Choose a reason for hiding this comment

shields-deployment bot commented Feb 14, 2020

agilgur5 commented Dec 4, 2019 •

edited

Loading

shields-ci commented Dec 4, 2019 •

edited

Loading

agilgur5 commented Dec 4, 2019 •

edited

Loading

PyvesB commented Dec 5, 2019 •

edited

Loading