List Commit History for a Pull Request
This method enables users to list the commit history for a pull request in a GitHub repository.
For more information on the API for listing commits on a pull request, see List commits on a pull request (opens in a new tab).
To use this API endpoint for a private repository, your GitHub token requires the following scopes:
For a Fine-grained token:
- "Pull requests" repository permissions (read)
Alternatively, for a Token (classic):
- repo
SDK Import:
from admyral.actions import list_github_merged_pull_requests
Arguments
Argument Name | Description | Required |
---|---|---|
Repository Owner repo_owner | The owner of the repository. | yes |
Repository Name repo_name | The name of the repository. | yes |
Pull Request Number pull_request_number | The number identifier of the pull request. | yes |
Returns
A JSON array of commits.
Required Secrets
Secret Placeholder | Description |
---|---|
GITHUB_SECRET | GitHub secret. See GitHub setup |
SDK Example
commit_diff = list_github_commit_history_for_pull_request(
repo_owner="admyral",
repo_name="admyral",
pull_request_number="3",
secrets={"GITHUB_SECRET": "your_github_secret"}
)