Add PR Description Using LinearB's AI
Use the describe-changes automation action to automatically generate and append a concise, AI-generated description to a pull request. This ensures that all PRs include meaningful and helpful descriptions, improving review efficiency.
Configuration Description
Conditions (all must be true):
- A PR is created or new code has been committed to the PR.
Automation Actions:
- Append the AI-generated description to the PR description.
Configuration Example
manifest:
version: 1.0
automations:
linearb_ai_description:
# trigger it only when PR is created or has new commits
on:
- pr_created
- commit
# skip description for Draft PRs and PRs from bots
if:
- {{ not pr.draft }}
- {{ pr.author | match(list=['github-actions', 'dependabot', '[bot]']) | nope }}
run:
- action: describe-changes@v1
args:
concat_mode: append
Additional Resources
gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.
Learn More about how gitStream Works.
Related Automations:
- Estimate the amount of time it would require someone to complete a PR review.
- Flag missing Jira ticket information
- Label PRs that delete files.
- Label PRs that lack tests
- Provide information about what percent of a PR is new code.
- Request PR authors to provide screenshots in relevant PRs.
More Automations can be found on the Automation Library and Integrations pages.