Github Issues API reporting - Githubissues

inkwork / gs-proposal

Apache License 2.0

1 stars 1 forks source link

Github Issues API reporting #4

Open chrissimpkins opened 5 years ago

chrissimpkins commented 5 years ago

Goal

Automate reporting of new and resolved work issues for project work under git version control in remote Github repositories.

The ideal approach:

uses Github issue reporting workflows (the vendor-specific approach is very debatable, perhaps a vendor-independent approach is better if API are available on GitLab, BitBucket, etc)
uses issue title to define new issues
uses issue title to define resolved issues
is flexible and gracefully falls back if Github API is not accessible or Github is not used for source

Data Needs

via Github API:

Issues opened since X date (e.g., last report date)
Issues closed since X date (e.g., last report date)
Total opened / total closed

Visualization Options

bar chart (# opened and # closed by timeframe)
Markdown table formatting --> HTML table layout with opened / closed fields & titles of issue reports

chrissimpkins commented 5 years ago

Github API for issues with filters for:

sorting by date
filtering by date since
filtering by open / closed

https://developer.github.com/v3/issues/#parameters