This plugin adds support for GitHub events and related variables to Firebot.
- Firebot 5.65 or higher
- Copy the
firebot-github.jsfile into your Firebot profile'sscriptsfolder (e.g.%appdata%\Firebot\v5\profiles\Main Profile\scripts) - Go to Settings > Scripts in Firebot
- Click on "Manage Startup Scripts"
- Click "Add New Script"
- Select the
firebot-github.jsfile from the dropdown list - Click "Add & Configure"
- Click the "Copy URL" button under "Webhook URL", then close both the script settings and the "Startup Scripts" modals
- In the GitHub repo(s) you want to receive events from, under Settings > Webhooks, create a new webhook, paste the copied URL into the Payload URL field, select which events you want GitHub to send for that repo, and click "Add webhook"
New events:
- GitHub: Issue Opened
- GitHub: Issue Closed
- GitHub: Ping
- GitHub: Pull Request Opened
- GitHub: Pull Request Closed
- GitHub: Push
- GitHub: Release Created
- GitHub: Release Deleted
- GitHub: Release Prereleased
- GitHub: Release Published
- GitHub: Release Released
- GitHub: Repo Forked
- GitHub: Repo Starred
- GitHub: Workflow Run Requested
- GitHub: Workflow Run Completed
New variables:
$githubForkRepoFullName$githubForkRepoName$githubForkRepoUrl$githubIssueBody$githubIssueId$githubIssueState$githubIssueTitle$githubIssueType$githubIssueUrl$githubOrgAvatarUrl$githubOrgDescription$githubOrgName$githubOrgUrl$githubPullRequestBody$githubPullRequestMerged$githubPullRequestNumber$githubPullRequestTitle$githubPullRequestUrl$githubPushCompareUrl$githubPushFilesAdded$githubPushFilesModified$githubPushFilesRemoved$githubPushMessage$githubPushNewCommit$githubPushPreviousCommit$githubPushRef$githubPushWasForced$githubReleaseUrl$githubReleaseVersion$githubRepoForks$githubRepoFullName$githubRepoIsFork$githubRepoName$githubRepoStars$githubRepoUrl$githubStarredAt$githubUserAvatarUrl$githubUserId$githubUsername$githubUserProfileUrl$githubWebhookEvents$githubWebhookId$githubWebhookIsActive$githubWebhookName$githubWorkflowBadgeUrl$githubWorkflowId$githubWorkflowName$githubWorkflowState$githubWorkflowUrl$githubWorkflowRunConclusion$githubWorkflowRunId$githubWorkflowRunName$githubWorkflowRunStatus$githubWorkflowRunUrl