cffbots / filtering

Tool to discover github repos that could benefit from cffconvert-github-action
Apache License 2.0
1 stars 0 forks source link

decide on input/output for the filters #15

Closed jspaaks closed 2 years ago

jspaaks commented 2 years ago

What will the filters of #1 pass to each other, how will they do it?

jspaaks commented 2 years ago

If we're interested in collecting metrics, we may need something like an array of objects, like:

[{
   "url": "https://github.com/theorg/therepo",
   "has_cff": true,
   "accepts_prs": true,
   "cffversion": "1.0.3",
   "uses_workflows": true
}, {
   "url": "https://github.com/theorg/therepo2",
   "has_cff": false,
   "accepts_prs": true,
   "cffversion": "1.2.0",
   "uses_workflows": false
}]

If we're only interested in filtering, probably an array of repo name strings is sufficient (Also this is much more efficient in terms of the number of requests we're making to github's api).

jspaaks commented 2 years ago

We decided to use the array of objects or a table, with each filtering function adding one or more keys or columns to each object in the array.

We decided against pure filters that make the initiali set of repository names smaller

We decided to have pure filtering of a list of repo URLS