bryanmacfarlane / project-reports-action Goto Github PK

I was walking through the configuration types to de-any them and noticed a couple of discrepancies:

Project Done

In project-done.ts, we look for both "report-on" and "report-on-label", but the documentation only mentions "report-on-label". Can we remove the check for "report-on", or does the documentation need to be updated?

&c. I will add more as I find them.

Currently, statuses sort by string since they're just "red", "yellow", or "green", so their sort isn't really meaningful:

Instead, it might be nice to convert them to integer enums for the output so that we can sort 0/green, 1/yellow, 2/red.

Can we track repo issues without labels or based on assignee?

Also it would be good if we can track open PRs as well

Since we output the "reports" each in a directory with the name of the report, I'm wondering if we should transition "reports" in the config from a list:

reports:
  - name: Todo
    title: etc
  - name: Issues
    title: etc

To a map:

reports:
  Todo:
    title: etc
  Issues:
    title: etc

This would enforce the uniqueness of names, which is currently implicit and may cause bugs if users accidentally re-use names.

When the generator is building the processed data, it assumes that there is only one type of each section per config. When a config has, for example, "repo-issues" sections for multiple repositories, the "processed.json" output is overwritten each time we process a section, and when the generator is done, only the last "repo-issues" section in the config is represented by "processed.json".

I think the right way to fix this is to probably create a separate directory for each section—it just means that the directories need a unique identifier beyond just the section type name.