Inconsistent "gollum" webhook event payload - "pages" array "summary"

[JasperLorelai]

Select Topic Area

Bug

Body

Description:

The gollum webhook event payload has inconsistent content regarding the pages object array and its elements' summary property. When it comes to commits, their commit message usually follows the following format, where body is optional:

subject

body

When a commit is pushed to the wiki repository without the editor, passing the body is possible, but the wiki web editor only allows passing a subject.

The bug is: the summary field is documented as string or null. It returns null if a subject without a body present is committed as a message. If a summary and a body is present, the field only returns subject. The field should always return the string of the commit message.

Reproduction Steps:

1. Setup a webhook event listener or a GitHub workflow listening to the gollum event.
2. Setup logging for the edited pages field and its summary field.
3. Commit, without the web editor, changes to a wiki page, one with a commit message body, and one without.
4. The outcome should be that the one with the body will return the subject, and the one without the body will not return the subject, but null.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐