SCM Webhooks and PR Linking for Plural Flows
Setting up SCM webhooks and automatically linking Pull Requests to Plural Flows
Overview
Plural utilizes SCM (Source Control Management) webhooks to monitor pull request events and integrate with your development workflow. This allows Plural Flows to automatically link associated pull requests, enabling codebase root cause investigation in light of an alert or other issue.
Setting up SCM Webhooks
To enable features like automatic PR status labeling and linking PRs to Plural Flows, you need to configure an SCM webhook.
Prerequisites
- Plural Console
admin
Permissions - SCM Provider Personal Access Token (Refer to provider documentation for creation: Github, GitLab, Bitbucket)
- SCM Provider Organization
admin
Permissions (Required only when creating the webhook initially)
Creating the Webhook in Plural
- Navigate to
https://{your-console-domain}/pr/scm-webhooks
in your Plural Console. - Click the
Create Webhook
Button at the top right. - Fill in the Required Fields:
- Provider Type: Select the SCM Provider (GitHub, GitLab, Bitbucket).
- Owner: The Organization or Group within the SCM Provider.
- Secret: A shared secret for webhook verification. You can generate one using
plural crypto random
.
- Click
Create
. - Copy the generated Webhook URL and note the secret you provided.
Configuring the Webhook in your SCM Provider
Now, use the copied Webhook URL and secret to create a webhook within your SCM provider's settings. You can typically configure this at the repository or organization/group level.