Docs / Workflows / Integrations / GitHub
GitHub
Read repository code and activity, manage issues and comment on pull requests through a GitHub App installation.
What you can do
Each GitHub integration’s page in OAIZ shows these uses, with its events and its read and write actions, under What you can do with GitHub.
- Pull request reviews
- Review each pull request and comment on the changes.
- Bug issues
- Create an issue from each bug report.
- Failed runs
- Report failed workflow runs together with their logs.
Connection scope
The GitHub App installation determines which repositories the connection reaches. Repository inputs use owner/repository names. Issue and pull request actions use their repository-local numbers. File reads use a branch, tag or commit reference.
Connecting
Install the OAIZ GitHub App on the account or organization that owns the repositories. In GitHub’s installation screen, select all repositories or the specific repositories the connection should reach, then return to OAIZ.
- Repository permissions
- Contents, Issues, Pull requests and Checks: read and write. Actions and Metadata: read-only.
- Organization permission
- Members: read-only, for organization membership information.
Adding another repository requires granting the app access to it in GitHub.
Read actions
- List Issues
- List issues in a GitHub repository with optional filters for state, labels, assignee, and sorting.
- Get Issue
- Read an issue’s title, description, state, labels and assignees.
- Get Issue Comments
- Get comments on a GitHub issue with pagination support.
- Search Issues
- Search issues with GitHub query syntax, including repository, state, label and date filters.
- Get Release
- Get the notes and asset details of a published GitHub release by repository and tag.
- List Releases
- List one page of GitHub releases visible in a repository, including drafts when the connection can see them.
- List Pull Requests
- List pull requests in a GitHub repository with optional filters for state, sort, base branch, and head branch.
- Get Pull Request
- Read a pull request’s title, description, state, branches and merge status.
- Search Pull Requests
- Search pull requests with GitHub query syntax.
- Get Pull Request Diff
- Get the unified diff of a pull request's changes.
- Get Pull Request Files
- List the files changed in a pull request with additions, deletions, and patch details.
- Get Pull Request Comments
- Get discussion comments on a pull request with pagination support.
- Get Pull Request Reviews
- Get reviews on a pull request including approval status and review comments.
- Get Repositories
- List repositories available to the installation.
- Search Repositories
- Search repositories by name and GitHub query filters.
- Get Labels
- Get a list of available GitHub labels for a repository.
- List Branches
- List branches in a GitHub repository with pagination support.
- Get File Contents
- Read one repository file at a branch, tag or commit.
- List Repository Tree
- List repository files and directories, with optional recursive listing and cursor pagination.
- Search Code
- Find matching code within one repository.
- Batch Get File Contents
- Read up to 10 known file paths from one GitHub repository and ref, optionally with the same line range.
- List Commits
- List commits in a GitHub repository with optional filters for branch, author, date range, and file path.
- Compare Refs
- Compare two repository branches, tags or commits and return their differences.
- List Workflow Runs
- List GitHub Actions workflow runs in a repository with optional filters for branch, status, event, and actor.
- Get Workflow Run
- Read a workflow run’s status, conclusion and timing.
- Get Workflow Run Logs
- Read a workflow run’s logs.
Write actions
- Create Issue
- Create an issue in a GitHub repository.
- Comment on Issue
- Add a comment to an existing GitHub issue.
- Update Issue
- Update an existing GitHub issue.
- Update Release
- Replace a published release’s title or notes by repository and tag. An omitted field stays unchanged. Empty notes clear them.
- Close Issue
- Close a GitHub issue.
- Reopen Issue
- Reopen a closed GitHub issue.
- Add Labels to Issue
- Add labels to a GitHub issue.
- Remove Labels from Issue
- Remove labels from a GitHub issue.
- Comment on Pull Request
- Add a comment to a GitHub pull request.
- Create Inline Comment
- Add a review comment to a file and line in a pull request’s diff.
- Create Check Run
- Create a check run on a commit in a GitHub repository.
- Update Check Run
- Change a check run’s status, conclusion or displayed results.
Events
Repository webhooks report supported issue, pull request, comment, release, workflow and other repository changes. Event properties identify the repository and affected item. A workflow can react to those IDs and then read the current item through an action.