thoughtworks / metrik

An easy-to-use, cross-platform measurement tool that pulls data out of CD pipelines and analysis the four key metrics for you.
MIT License
359 stars 87 forks source link

fix: mismatch of parameter and value #106

Closed marcohutzsch1234 closed 1 year ago

marcohutzsch1234 commented 2 years ago

this fixes an exception which appears when a branch name is passed into the api request to the sha query parameter. Fixed to be consistent witch parameters and values to branch, usage of sha would only get a single commit.

marcohutzsch1234 commented 2 years ago

Any updates on this PR?

ZhongwenLian commented 2 years ago

Hi @marcohutzsch1234, we will take a look at Github's api documentation and get back to you!

LixingSun commented 2 years ago

Hi @marcohutzsch1234, the current implementation it is based on Github API doc where the sha parameter is described as

SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

which is accepting value as either sha or branch. Currently from our a few testing the sha is still working as expected when passing branch name as its value.

Could you please help share a bit more details about the "exception" you have met and where does the branch parameter come from? (We have tried to pass the branch name as branch parameter and indeed it looks like can perform same as sha parameter. But since we could not find Github official doc about this parameter so we are a bit concerning on it e.g. whether it is still an experimental feature and how is the performance, etc.)