|
| 1 | +--- |
| 2 | +title: Automation - Generate PR Description from Commit Messages |
| 3 | +description: Automatically generate Pull Request descriptions based on commit messages. |
| 4 | +category: [quality, productivity] |
| 5 | +--- |
| 6 | +# Generate PR Description from Commit Messages |
| 7 | + |
| 8 | +Generate Pull Request descriptions automatically based on commit messages. |
| 9 | +This automation is useful for ensuring that PR descriptions are consistent and informative. |
| 10 | + |
| 11 | +!!! warning "Required gitStream Plugins" |
| 12 | + This example requires you to install the [`generateDescription`](/filter-function-plugins/#generatedescription) plugin. |
| 13 | + |
| 14 | + [Learn more about gitStream plugins](/plugins/). |
| 15 | + |
| 16 | +<div class="automationImage" style="align:right" markdown="1"> |
| 17 | + |
| 18 | +</div> |
| 19 | +<div class="automationDescription" markdown="1"> |
| 20 | +!!! info "Configuration Description" |
| 21 | + Conditions (all must be true): |
| 22 | + |
| 23 | + * Every PR. |
| 24 | + |
| 25 | + Automation Actions: |
| 26 | + |
| 27 | + * Update the PR description with auto generated content based on commit messages. |
| 28 | +</div> |
| 29 | +<div class="automationExample" markdown="1"> |
| 30 | +!!! example "Generate PR Description" |
| 31 | + ```yaml+jinja |
| 32 | + --8<-- "docs/downloads/automation-library/auto_pr_description.cm" |
| 33 | + ``` |
| 34 | + <div class="result" markdown> |
| 35 | + <span> |
| 36 | + [:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/auto_pr_description.cm"){ .md-button } |
| 37 | + </span> |
| 38 | + </div> |
| 39 | +</div> |
| 40 | + |
| 41 | +## Additional Resources |
| 42 | + |
| 43 | +--8<-- "docs/snippets/general.md" |
| 44 | + |
| 45 | +**Related Automations**: |
| 46 | + |
| 47 | +--8<-- "docs/snippets/context-automation.md::2" |
| 48 | +--8<-- "docs/snippets/context-automation.md:4:" |
| 49 | + |
| 50 | +--8<-- "docs/snippets/automation-footer.md" |
0 commit comments