The Github Get Commit List action is used to retrieve the commit list for a specific GitHub repository. This action allows you to obtain detailed information about a project's commit history, including who made the commits and when. It is ideal for version control, code review, and change tracking, especially in software development processes.
Technical Specifications
Get Commit List (Commit Panel): This action lists the commits belonging to the relevant repository and returns the Github_list_commits_Result object.
Parameters:
settings (Object – required): Contains the settings required for the GitHub API connection. The GitHub setting defined via the Configuration Manager should be selected here.
author (String – optional): Author information to filter commits. (e.g., octocat)
owner (String – required): The owner of the repository. (e.g., kuika)
repo (String – required): The name of the repository from which to retrieve commits. (e.g., platform-docs)
page (Decimal – optional): The current page number for pagination.
perPage (Decimal – optional): The number of commits to fetch per page. (e.g., 20)
sha (String – optional): Used to filter commits by a specific branch or SHA.
Data Source Compatibility: All parameters can be entered as fixed values or retrieved from dynamic sources such as Form Input, Current, Action Result, Method Input via the Symbol Picker.
Web & Mobile Support: The GitHub Get Commit List action can be used in both web and mobile applications.
Github Get Commit List Application Steps
1. Defining the Action in UI Design
Open your Kuika project.
In the UI Design module, select the screen where the commit list will be displayed.
Add a Button (e.g., “Show Commits”).
Click on the button and select the + ADD ACTION → Github → Github Get Commit List action.
2. Configuring Parameters
settings: Select the GitHub API setting you created in Configuration Manager.
owner: Enter the repository owner (e.g., kuika).
repo: Enter the repository name (e.g., platform-docs).
author, page, perPage, sha: Can be filled in optionally as needed.
Use Case: Displaying Commit History
In a project management application, the user wants to view the commit history by entering the repository name and owner.
Steps:
Add a “Show Commits” button.
Add the OnClick → Github Get Commit List action.
Link the owner and repo parameters to user input.
Display the returned results on the screen using the Table element.
Github Get Commit List Advanced Customizations
Filter by Author: You can list commits by a specific developer.
Pagination Usage: Since there may be a large number of commits in large projects, page-based listing can be done with the page and perPage parameters.
Branch-Based Review: Only commits belonging to a specific branch can be retrieved using the sha parameter.
Use of Results: The retrieved commit information can be used for tasks such as reporting, sending notifications, or updating dashboards.
Technical Risks and Controls
owner and repo must not be empty. Otherwise, the operation will fail.
settings must be configured correctly. If the GitHub API setting is not configured in Configuration Manager, the action will not work.
GitHub rate limit: If queries are made too frequently, you may hit the GitHub API limit.
Large data set: A large number of commits may be returned; therefore, pagination is recommended.