Steps that allow various interactions with GitHub
GitHub - Get Last Commit : queries for the last commit for a branch or tag and returns detailsGitHub - Get Commit : queries for a specific commit and returns detailsGetHub - Get Pull Request : queries for a specific pull request and returns detailsGetHub - Trigger Workflow : triggers a GitHub workflow
Create a personal access token
Download the GitHubSteps.zip file onto your local computer
Navigate to Workflows of your xMatters instance
Click Import, and select the zip file you just downloaded
Create and/or open the workflow you want to use the GitHub steps in
Go to the Flow Designer tab, open the Components menu in the top right, and select Endpoints
Add a new endpoint and enter the following information
Name = GitHub
Base URL = https://api.github.com
Endpoint Type = Basic
Username = GitHub username
Password = GitHub personal access token
Preemptive = checked
The GitHub - Get Last Commit step can be used to query for the last commit for a branch or tag. It will return various details.
Name
Required?
Min
Max
Help Text
Default Value
Multiline
Continue On Error
No
0
5
Continue flow if step encounters an error. Other steps could fail if they depend on outputs
false
No
Repository Owner
No
0
2000
The repository owner or organization
No
Repository Name
No
0
2000
The name of the repository
No
Ref
No
0
2000
Branch or Tag
No
Name
Description
URL
URL to the commit
SHA
The SHA hash of the commit
Committer Name
Full name of the author
Committer Email
Email address of the author
Author Name
Full name of the author
Author Email
Email address of the author
Timestamp
Timestamp of the commit.
Message
Commit message
Slack Changes
Changes in Slack markdown format
HTML Changes
Changes in HTML format
Step Error
true or false depending on if step encountered an error
The GitHub - Get Commit step can be used to query for a specific commit using its SHA. It will return various details.
Name
Required?
Min
Max
Help Text
Default Value
Multiline
Continue On Error
No
0
5
Continue flow if step encounters an error. Other steps could fail if they depend on outputs
false
No
Repository Owner
No
0
2000
The repository owner or organization
No
Repository Name
No
0
2000
The name of the repository
No
SHA
No
0
2000
The SHA hash of the commit
No
Name
Description
URL
URL to the commit
Committer Name
Full name of the author.
Committer Email
Email address of the author.
Author Name
Full name of the author
Author Email
Email address of the author
Timestamp
Timestamp of the commit
Message
Commit message
Slack Changes
Changes in Slack markdown format
HTML Changes
Changes in HTML format
Step Error
true or false depending on if step encountered an error
GitHub - Get Pull Request The GitHub - Get Pull Request step can be used to query for a specific pull request by number. It will return various details.
Name
Required?
Min
Max
Help Text
Default Value
Multiline
Continue On Error
No
0
5
Continue flow if step encounters an error. Other steps could fail if they depend on outputs
false
No
Repository Owner
No
0
2000
The repository owner or organization
No
Repository Name
No
0
2000
The name of the repository
No
Pull Request Number
No
0
2000
The pull request number
No
Name
Description
URL
URL to the pull request
Requestor Name
Name of the requestor
Timestamp
Timestamp of the commit.
Title
Pull request title
Message
Commit message
Source
Pull request source
Target
Pull request target
Step Error
true or false depending on if step encountered an error
GitHub - Trigger Workflow The GitHub - Trigger Workflow step can be used to start a GitHub workflow with a "workflow_dispatch" trigger.
The workflow must be set to trigger on "workflow_dispatch"
Name
Required?
Min
Max
Help Text
Default Value
Multiline
Continue On Error
No
0
5
Continue flow if step encounters an error. Other steps could fail if they depend on outputs
false
No
Repository Owner
No
0
2000
The repository owner or organization
No
Repository Name
No
0
2000
The name of the repository
No
Workflow
No
0
2000
Workflow ID or file name
No
Ref
No
0
2000
Branch or Tag where the workflow is located
No
Workflow Inputs
No
0
20000
Comma separated list of key value pairs for the inputs of the GitHub Action workflow. ("input1":"value1","input2":"value"
No
Name
Description
Step Error
true or false depending on if step encountered an error
