Customize PR templates
Release status Customize PR templates is currently in Closed Beta and available only for Enterprise plans. The functionality is likely to evolve based on feedback, and there will be breaking changes.
Contact your account manager to get access to this feature. After your account manager turns on the feature flag, you can activate this feature in the Snyk Preview.
Understand Customized PRs
When you fix or upgrade Snyk Open Source and Container Projects imported using the SCM integrations, Snyk raises pull requests (PRs) against your repository.
Snyk has default templates for the title, description and commit message. These indicate what packages are being changed, which issues are being fixed, and many other details.
You may have your own standards and practices for submitting pull requests. For instance, if a pull request comes from Snyk, you may require the title to begin with SNYK:. This page identifies the areas of pull requests that you can customize and provides instructions on how to do so.
On the supported languages, frameworks, and feature availability overview page, you can find all the languages for which the Fix PR functionality is supported.
Snyk is looking initially for feedback on the variables and templating system. After the approach is validated, Snyk will look into building more robust authoring workflows using the API and UI interfaces.
Enable the Customize PR feature
Follow these steps to enable the Configure Snyk Pull Requests feature:
Log in to your Snyk account.
Select Settings, then Snyk Preview.
Enable the Configure Snyk Pull Requests feature. You can enable this feature at the Group level. See Configure Automatic fix PRs for more configuration details.
API support
Customize your PR template automatically by making an API request; see Create an API request with a Custom template. For more information, see the Snyk API pull request templates endpoints.
Last updated
