Skip to content

Commit 742c7a9

Browse files
committed
Merge remote-tracking branch 'origin/add-generate-pr-desc-automation' into add-generate-pr-desc-automation
2 parents 7f29e64 + a4d8043 commit 742c7a9

File tree

1 file changed

+5
-6
lines changed
  • docs/automations/generate-pr-description

1 file changed

+5
-6
lines changed

docs/automations/generate-pr-description/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,27 @@ title: Automation - Generate PR Description from Commit Messages
33
description: Automatically generate Pull Request descriptions based on commit messages.
44
category: [quality, productivity]
55
---
6-
# Generate PR Description from Commit Messages
6+
# Automatically Generate PR Description from Commit Messages
77

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

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

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

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

23-
* Every PR.
22+
* A PR is created or has commits added to it.
2423

2524
Automation Actions:
2625

27-
* Update the PR description with auto generated content based on commit messages.
26+
* Update the PR description with auto-generated content based on commit messages.
2827
</div>
2928
<div class="automationExample" markdown="1">
3029
!!! example "Generate PR Description"

0 commit comments

Comments
 (0)