Skip to content

Commit 5096433

Browse files
authored
Merge branch 'main' into flag-amazon-q-pr
2 parents fbb6830 + eb7b073 commit 5096433

File tree

33 files changed

+244
-126
lines changed

33 files changed

+244
-126
lines changed

docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Notify PR authors to ensure proper Javadoc coverage.
44
category: [docs, java]
55
---
66
# Review Java Input Parameters for Javadoc Changes
7+
<!-- --8<-- [start:example]-->
78

89
If a PR modifies the input parameters for a Java method, but not the associated Javadocs, notify reviewers to check for Javadoc updates.
910

@@ -35,3 +36,5 @@ If a PR modifies the input parameters for a Java method, but not the associated
3536
</span>
3637
</div>
3738
</div>
39+
40+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-javadoc-large-change/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically flag large PRs that may require Javadoc updates.
44
category: [docs, java]
55
---
66
# Review Javadoc for Large Changes
7+
<!-- --8<-- [start:example]-->
78

89
Require more extensive reviews for large Java changes that lack Javadoc updates.
910

@@ -35,3 +36,4 @@ Require more extensive reviews for large Java changes that lack Javadoc updates.
3536
</span>
3637
</div>
3738
</div>
39+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-javadoc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically approve PRs that only contain Javadoc changes.
44
category: [docs, java]
55
---
66
# Review Javadoc Changes
7+
<!-- --8<-- [start:example]-->
78

89
Unblock PRs that only change Javadoc content.
910

@@ -36,3 +37,4 @@ Unblock PRs that only change Javadoc content.
3637
</span>
3738
</div>
3839
</div>
40+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-new-class-javadoc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically request changes for PRs that fail to meet Javadoc req
44
category: [docs, java]
55
---
66
# Enforce Javadoc Requirements for New Classes
7+
<!-- --8<-- [start:example]-->
78

89
Automatically request changes when someone creates a new Java class that lacks Javadoc content.
910

@@ -34,3 +35,4 @@ Automatically request changes when someone creates a new Java class that lacks J
3435
</span>
3536
</div>
3637
</div>
38+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jit/label-jit-alerts/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: Automatically label PRs with Jit findings.
44
category: [security, jit]
55
---
66
# Label Jit Alerts
7+
<!-- --8<-- [start:example]-->
8+
79
Label the number of high, medium, and low risk vulnerabilities Jit reports for PRs.
810

911
<div class="automationImage" markdown="1">
@@ -30,3 +32,4 @@ Label the number of high, medium, and low risk vulnerabilities Jit reports for P
3032
</span>
3133
</div>
3234
</div>
35+
<!-- --8<-- [end:example]-->

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically assign PR reviewers for Jit security alerts.
44
category: [security, jit]
55
---
66
# Review Jit Security Alerts
7+
<!-- --8<-- [start:example]-->
78
Manage review assignment for high and medium risk Jit security alerts.
89

910
<div class="automationImage" markdown="1">
@@ -40,3 +41,4 @@ Manage review assignment for high and medium risk Jit security alerts.
4041
</span>
4142
</div>
4243
</div>
44+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jit/review-jit-ignore-accept/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically notify your security team when someone ignores Jit vu
44
category: [security, jit]
55
---
66
# Review Jit Ignore and Accept
7+
<!-- --8<-- [start:example]-->
78
Notify your Security team when someone ignores a Jit vulnerability report and accepts the risk.
89

910
<div class="automationImage" markdown="1">
@@ -33,3 +34,4 @@ Notify your Security team when someone ignores a Jit vulnerability report and ac
3334
</span>
3435
</div>
3536
</div>
37+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jit/review-jit-secret/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically block PRs that contain secrets.
44
category: [security, jit]
55
---
66
# Review Jit Secret Detection
7+
<!-- --8<-- [start:example]-->
78
Close PRs where Jit detects a secret and post a comment explaining steps to remedy the situation.
89

910
<div class="automationImage" markdown="1">
@@ -32,3 +33,4 @@ Close PRs where Jit detects a secret and post a comment explaining steps to reme
3233
</span>
3334
</div>
3435
</div>
36+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jsdoc/review-jsdoc-input/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Automatically flag PRs that may require JSDoc updates.
44
category: [docs, javascript]
55
---
66
# Review JSDoc Input Parameters
7-
7+
<!-- --8<-- [start:example]-->
88
Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content.
99

1010

@@ -34,3 +34,4 @@ Warn PR authors when they change JavaScript function or constructor input parame
3434
</span>
3535
</div>
3636
</div>
37+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jsdoc/review-jsdoc-large/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Automatically flag large PRs that may require JSDoc updates.
44
category: [docs, javascript]
55
---
66
# Review JSDoc for Large Changes
7-
7+
<!-- --8<-- [start:example]-->
88
Require more extensive reviews for large JavaScript changes that lack JSDoc updates.
99

1010
<div class="automationImage" markdown="1">
@@ -35,3 +35,4 @@ Require more extensive reviews for large JavaScript changes that lack JSDoc upda
3535
</span>
3636
</div>
3737
</div>
38+
<!-- --8<-- [end:example]-->

0 commit comments

Comments
 (0)