These steps allow you to get the commit details from a given project. Great for enriching notifications with relevant code commit information.
- GitLabSteps.zip - Workflow zip file with these steps and example flow
- gitlab.png - GitLab logo
These steps pull from various API endpoints in GitLab to get commit detils.
If you are trying to access a public project, then none.
If your project is private, then you will need to authenticate with an API Token.
Create a Personal API Token by following these instructions.
- Download the GitLabSteps.zip file onto your local computer
- Navigate to the Developer tab of your xMatters instance
- Click Import, and select the zip file you just downloaded
Optionally:
- Change the GitLab endpoint if your project is hosted outside of GitLab.
- Add an authentication token constant and provide it when calling a GitLab step.
Get All Commits
| Name | Required? | Min | Max | Help Text | Default Value | Multiline |
|---|---|---|---|---|---|---|
| Project ID | Yes | 0 | 2000 | The ID or URL-encoded path of the project owned by the authenticated user | No |
| Name | Description |
|---|---|
| Commits | List of Commit Objects |
Get Single Commit
| Name | Required? | Min | Max | Help Text | Default Value | Multiline |
|---|---|---|---|---|---|---|
| Project ID | Yes | 0 | 2000 | The ID or URL-encoded path of the project owned by the authenticated user | No | |
| SHA | Yes | 0 | 2000 | The commit hash or name of a repository branch or tag | No |
| Name | Description |
|---|---|
| URL | URL of the project |
| Author_Name | Full name of the author |
| Author_Email | Email address of the author |
| Timestamp | Timestamp of the commit |
| Message | Commit message |
Get Projects
| Name | Required? | Min | Max | Help Text | Default Value | Multiline |
|---|---|---|---|---|---|---|
| User ID | Yes | 0 | 2000 | The ID or username of the user | No |
| Name | Description |
|---|---|
| Projects | List of Project Objects |
This is the flow provided.
