Search code examples
githubmarkdowngithub-apigithub-flavored-markdown

Is there Task Completion info on GitHub Issues API?


On GitHub Flavored Markdown you can write something like:

- [ ] Subtask 1
- [ ] Subtask 2
- [x] Subtask 3

This will render as a list of three checkboxes, the last one checked. That also gives a nice bonus to Issues listing as it includes a progress bar for the given issue:

Three issues with progress bar

Is this present in the GitHub API? If not, how could we achieve that? Only by manually parsing the Issue body? Finally, is there a specific place for requesting API features?


Solution

  • Is this present in the GitHub API?

    No. The GitHub API does not currently expose task completion progress.

    If not, how could we achieve that? Only by manually parsing the Issue body?

    That is probably your best bet at the moment.

    Finally, is there a specific place for requesting API features?

    Indeed! Get in touch at https://github.com/contact. GitHub welcomes feature requests, and it's especially helpful if you can explain how a particular feature would benefit you (e.g., a description of the workflows that a particular API enhancement would enable).