Skip to content

Commit 61fa14f

Browse files
Merge branch 'main' into checklist-plugin
2 parents cfccf93 + 3a20177 commit 61fa14f

File tree

75 files changed

+1415
-375
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1415
-375
lines changed

docs/assets/gitstream-black.png

10.8 KB
Loading

docs/assets/gitstream-white.png

3.49 KB
Loading

docs/automation-actions.md

Lines changed: 188 additions & 95 deletions
Large diffs are not rendered by default.

docs/automations/approve-tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Automation - Approve test changes
33
description: Automatically approve changes that only contain updates to tests.
4-
category: [efficiency, testing, quickstart]
4+
category: [efficiency, testing]
55
quickstart: true
66
---
77
# Approve test changes
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
# Automatically Generate PR Description from Commit Messages
7+
8+
Automatically generate Pull Request descriptions based on commit messages. This automation helps ensure PR descriptions are consistent and informative.
9+
10+
!!! warning "Required gitStream Plugins"
11+
This example requires you to install the [`generateDescription`](/filter-function-plugins/#generatedescription) plugin.
12+
13+
[Learn more about gitStream plugins](/plugins/).
14+
15+
<div class="automationImage" style="align:right" markdown="1">
16+
![Automatically generate PR descriptions](generate-pr-description-example.png)
17+
</div>
18+
<div class="automationDescription" markdown="1">
19+
!!! info "Configuration Description"
20+
Conditions (all must be true):
21+
22+
* A PR is created or has commits added to it.
23+
24+
Automation Actions:
25+
26+
* Update the PR description with auto-generated content based on commit messages.
27+
</div>
28+
<div class="automationExample" markdown="1">
29+
!!! example "Generate PR Description"
30+
```yaml+jinja
31+
--8<-- "docs/downloads/automation-library/generate_pr_description.cm"
32+
```
33+
<div class="result" markdown>
34+
<span>
35+
[:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/generate_pr_description.cm){ .md-button }
36+
</span>
37+
</div>
38+
</div>
39+
40+
## Additional Resources
41+
42+
--8<-- "docs/snippets/general.md"
43+
44+
**Related Automations**:
45+
46+
--8<-- "docs/snippets/context-automation.md::2"
47+
--8<-- "docs/snippets/context-automation.md:4:"
48+
49+
--8<-- "docs/snippets/automation-footer.md"
80.3 KB
Loading

docs/automations/integrations/copilot/flag-copilot-pr/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Automation - Label GitHub Copilot PRs
33
description: Automatically apply labels to PRs that are assisted by GitHub Copilot
4-
category: [quality, genai, copilot]
4+
category: [quality, genai, copilot, quickstart]
55
---
66
# Automatically Label GitHub Copilot PRs
77
<!-- --8<-- [start:example]-->

docs/automations/integrations/dependabot/approve-dependabot/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Automation - Approve and Merge Dependabot Changes
33
description: Automatically approve and merge Dependabot PRs.
4-
category: [efficiency, dependabot, security]
4+
category: [efficiency, dependabot, security, quickstart]
55
quickstart: false
66
---
77
# Approve and Merge Dependabot Changes

docs/automations/integrations/orca/review-orca-alerts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Automation - Review Orca Security Alerts
33
description: Automatically require review from your SecOps team for Orca Security violations in pull requests.
4-
category: [security, orca, quickstart]
4+
category: [security, orca]
55
quickstart: true
66
---
77
# Require Security Review for Orca Alerts
Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,67 @@
11
---
22
title: Automation - Approve and Merge Renovate Changes
33
description: Automatically approve and merge Renovate PRs.
4-
category: [security, renovate]
4+
category: [efficiency, renovate, security, quickstart]
5+
quickstart: false
56
---
67
# Approve and Merge Renovate Changes
7-
88
<!-- --8<-- [start:example]-->
9-
Approve PRs from Renovate
9+
Auto-merge Renovate PRs
10+
11+
=== "By Release Type"
12+
13+
!!! warning "Required gitStream Plugins"
14+
This example requires you to install the [`extractRenovateVersionBump`](/filter-function-plugins/#extractrenovateversionbump), [`compareMultiSemver`](/filter-function-plugins/#comparemultisemver) and [`compareSemver`](/filter-function-plugins/#comparesemver) plugins.
15+
16+
[Learn more about gitStream plugins](/plugins/).
17+
18+
!!! info "Configuration Description"
19+
20+
Conditions (all must be true):
21+
22+
* The PR author is Renovate.
23+
* The branch name includes 'renovate'
24+
* The dependency change is a patch or minor update.
25+
26+
Automation Actions:
27+
28+
* Approve the PR
29+
* Apply an `approved-renovate` label to the PR
30+
* Merge the PR if all status checks pass.
31+
32+
!!! example "Configuration Example"
33+
```yaml+jinja
34+
--8<-- "docs/downloads/automation-library/integrations/renovate/approve_renovate_minor.cm"
35+
```
36+
<div class="result" markdown>
37+
<span>
38+
[:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/integrations/renovate/approve_renovate_minor.cm){ .md-button }
39+
</span>
40+
</div>
41+
42+
=== "All Updates"
43+
!!! info "Configuration Description"
1044

11-
![Approve and Merge Renovate Changes](/automations/integrations/renovate/approve-renovate/approve-renovate.png)
45+
Conditions (all must be true):
1246

13-
!!! info "Configuration Description"
47+
* The PR author is Renovate.
48+
* The branch name includes 'renovate'
1449

15-
**Conditions (all must be true):**
50+
Automation Actions:
1651

17-
* The PR author is Mend Renovate.
52+
* Approve the PR
53+
* Apply an `approved-renovate` label to the PR
54+
* Merge the PR if all status checks pass.
1855

19-
**Automation Actions:**
2056

21-
* Approve the PR
22-
* Apply an `approved-renovate` label to the PR
23-
* Merge the PR if all status checks pass.
57+
!!! example "Configuration Example"
58+
```yaml+jinja
59+
--8<-- "docs/downloads/automation-library/integrations/renovate/approve_renovate.cm"
60+
```
61+
<div class="result" markdown>
62+
<span>
63+
[:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/integrations/renovate/approve_renovate.cm){ .md-button }
64+
</span>
65+
</div>
2466

25-
<div class="automationExample" markdown="1">
26-
!!! example "Approve Renovate"
27-
```yaml+jinja
28-
--8<-- "docs/downloads/automation-library/integrations/renovate/approve-renovate/approve_renovate.cm"
29-
```
30-
<div class="result" markdown>
31-
<span>
32-
[:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/integrations/renovate/approve-renovate/approve_renovate.cm){ .md-button }
33-
</span>
34-
</div>
3567
<!-- --8<-- [end:example]-->

0 commit comments

Comments
 (0)