goodtables.io icon indicating copy to clipboard operation
goodtables.io copied to clipboard

Badge should show only the master branch status by default?

Open roll opened this issue 6 years ago • 4 comments

Overview

From @augusto-herrmann

In one of my repos https://github.com/augusto-herrmann/transparencia-dados-abertos-brasil , goodtables validates ok if I am on the master branch: goodtables data/valid/datapackage.json runs without errors. However, I have a few branches in the repo that are expected not to validate -- they're under development. However, the Goodtables.io badge shows as invalid, even when in github I am viewing the master branch. Is that expected behaviour, @roll ?


Please preserve this line to notify @amercader (lead of this repository)

roll avatar Oct 28 '19 13:10 roll

@amercader Can you comment on it? I'm not sure

roll avatar Oct 28 '19 13:10 roll

It seems that the badge looks only at the latest commit, regardless of which branch it is.

I've added a new commit to the branch with data that now validates. So now the badge shows the data as valid in all branches.

augusto-herrmann avatar Oct 29 '19 17:10 augusto-herrmann

It seems a bug

roll avatar Oct 30 '19 10:10 roll

It seems that the badge will show the latest of all commits, even if it is in a pending pull request.

See this example. The master branch is valid, but someone sent a pull request with invalid data, which is still pending, and now the repository's badge says it's invalid. The pull request, on the other hand, received no notification that it is invalid. So everything is the opposite of how it is supposed to work with a continuous data integration workflow.

I think the expected behaviour should be:

  • for a repository-wide badge, display the status of the main (or master) branch
  • for pull requests, have a CI workflow to display a clear message whether or not the PR contains valid data

augusto-herrmann avatar Jan 04 '21 10:01 augusto-herrmann