Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/add-generate-pr-desc-automation'…
Browse files Browse the repository at this point in the history
… into add-generate-pr-desc-automation
  • Loading branch information
vim-zz committed Aug 8, 2024
2 parents 7f29e64 + a4d8043 commit 742c7a9
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/automations/generate-pr-description/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,27 @@ title: Automation - Generate PR Description from Commit Messages
description: Automatically generate Pull Request descriptions based on commit messages.
category: [quality, productivity]
---
# Generate PR Description from Commit Messages
# Automatically Generate PR Description from Commit Messages

Generate Pull Request descriptions automatically based on commit messages.
This automation is useful for ensuring that PR descriptions are consistent and informative.
Automatically generate Pull Request descriptions based on commit messages. This automation helps ensure PR descriptions are consistent and informative.

!!! warning "Required gitStream Plugins"
This example requires you to install the [`generateDescription`](/filter-function-plugins/#generatedescription) plugin.

[Learn more about gitStream plugins](/plugins/).

<div class="automationImage" style="align:right" markdown="1">
![Example PR description](generate-pr-description-example.png)
![Automatically generate PR descriptions](generate-pr-description-example.png)
</div>
<div class="automationDescription" markdown="1">
!!! info "Configuration Description"
Conditions (all must be true):

* Every PR.
* A PR is created or has commits added to it.

Automation Actions:

* Update the PR description with auto generated content based on commit messages.
* Update the PR description with auto-generated content based on commit messages.
</div>
<div class="automationExample" markdown="1">
!!! example "Generate PR Description"
Expand Down

0 comments on commit 742c7a9

Please sign in to comment.