[Feature request] Expose Co-Authored-By Metadata in Commit API

[yeikel]

Use Case:

Identify all contributors to a commit, including those listed as Co-Authored-By in the commit message footer. Currently, the API exposes only the main author and committer, but not co-authors.

                    var userEmail = commit.getAuthor().getEmail();
                    var commiterEmail = commit.getCommitter().getEmail();
                    // How to get the co-author with this API? 

Proposed Solution:

• Add a method to GHCommit (or similar) that returns a list of co-authors parsed from the commit message.
• Optionally, provide a structured representation (e.g., name and email) for each co-author.

Example API:

List<GHUser> getCoAuthors();

References:

https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line

Note to maintainers:

Apologies if this is currently possible, please share any snippet if you can. Thank you in advance!

[bitwiseman]

This library tends to focus on matching the REST API objects. Not providing extra helpers beyond that.
I'm not opposed to adding more complex functionality, but it would need some design and planning.
Maybe some kind of helpers or util namespace with functions the are built on top of the core objects.

[yeikel]

This library tends to focus on matching the REST API objects.

I see, thank you! I assumed(incorrectly) that the GitHub API supported this as they ultimately parse and show that in the UI, but as you pointed out it doesn't.

[Haarolean]

I think they add these as a part of the commit message and that's it