Set author email when parsing push events

[hmacr]

Summary by CodeRabbit

• New Features
  • The commit author's email address is now extracted and made available for GitHub push events.

[coderabbitai]

Walkthrough

The update enhances the GitHub webhook event handling by extracting the commit author's email address from the 'head_commit' section for 'push' events. This email is then included in the event data returned by the getEvent method. No other logic or event types are affected.

Changes

File(s)	Change Summary
src/VCS/Adapter/Git/GitHub.php	Renamed $headCommitAuthor to $headCommitAuthorName and added extraction of commit author's email from 'head_commit' for 'push' events; both name and email are returned in the event data.

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

• Check value of deleted on push #42: Both PRs modify the getEvent method in the GitHub class to enhance the handling of the push event payload by extracting additional specific data fields, with the main PR adding author email and name, and the retrieved PR adding the branch deletion flag.

Suggested reviewers

• Meldiron

Poem

A hop and a skip through the code I go,
Finding the email in the commit's flow.
Now when you push, with each change you send,
The author’s address is there to append.
With whiskers a-twitch and a satisfied grin,
This rabbit declares: let the reviews begin! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 62392d8 and 414583f.

📒 Files selected for processing (1)

• src/VCS/Adapter/Git/GitHub.php (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/VCS/Adapter/Git/GitHub.php

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Meldiron]

This will be a breaking change, so it will require update in Appwrite's usage of library, but let's please rename this variable to headCommitAuthorName, to be consistent with newly added headCommitAuthorEmail.

[hmacr]

Agree on consistency - I was worried about backward compatibility.. if we can ensure compat, I'm down 👍