diff --git a/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md b/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md index e71d76061..5c804cedb 100644 --- a/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md +++ b/docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md @@ -4,6 +4,7 @@ description: Notify PR authors to ensure proper Javadoc coverage. category: [docs, java] --- # Review Java Input Parameters for Javadoc Changes + If a PR modifies the input parameters for a Java method, but not the associated Javadocs, notify reviewers to check for Javadoc updates. @@ -35,3 +36,5 @@ If a PR modifies the input parameters for a Java method, but not the associated + + diff --git a/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md b/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md index 2a930771d..b3889bb5d 100644 --- a/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md +++ b/docs/automations/integrations/javadoc/review-javadoc-large-change/README.md @@ -4,6 +4,7 @@ description: Automatically flag large PRs that may require Javadoc updates. category: [docs, java] --- # Review Javadoc for Large Changes + Require more extensive reviews for large Java changes that lack Javadoc updates. @@ -35,3 +36,4 @@ Require more extensive reviews for large Java changes that lack Javadoc updates. + diff --git a/docs/automations/integrations/javadoc/review-javadoc/README.md b/docs/automations/integrations/javadoc/review-javadoc/README.md index a01535670..57285a267 100644 --- a/docs/automations/integrations/javadoc/review-javadoc/README.md +++ b/docs/automations/integrations/javadoc/review-javadoc/README.md @@ -4,6 +4,7 @@ description: Automatically approve PRs that only contain Javadoc changes. category: [docs, java] --- # Review Javadoc Changes + Unblock PRs that only change Javadoc content. @@ -36,3 +37,4 @@ Unblock PRs that only change Javadoc content. + diff --git a/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md b/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md index da9c148a3..34feaf5ff 100644 --- a/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md +++ b/docs/automations/integrations/javadoc/review-new-class-javadoc/README.md @@ -4,6 +4,7 @@ description: Automatically request changes for PRs that fail to meet Javadoc req category: [docs, java] --- # Enforce Javadoc Requirements for New Classes + Automatically request changes when someone creates a new Java class that lacks Javadoc content. @@ -34,3 +35,4 @@ Automatically request changes when someone creates a new Java class that lacks J + diff --git a/docs/automations/integrations/jit/label-jit-alerts/README.md b/docs/automations/integrations/jit/label-jit-alerts/README.md index 6a84f97d5..88e74c1a3 100644 --- a/docs/automations/integrations/jit/label-jit-alerts/README.md +++ b/docs/automations/integrations/jit/label-jit-alerts/README.md @@ -4,6 +4,8 @@ description: Automatically label PRs with Jit findings. category: [security, jit] --- # Label Jit Alerts + + Label the number of high, medium, and low risk vulnerabilities Jit reports for PRs.
@@ -30,3 +32,4 @@ Label the number of high, medium, and low risk vulnerabilities Jit reports for P
+ diff --git a/docs/automations/integrations/jit/review-jit-alerts/README.md b/docs/automations/integrations/jit/review-jit-alerts/README.md index af08dcd50..94a358076 100644 --- a/docs/automations/integrations/jit/review-jit-alerts/README.md +++ b/docs/automations/integrations/jit/review-jit-alerts/README.md @@ -4,6 +4,7 @@ description: Automatically assign PR reviewers for Jit security alerts. category: [security, jit] --- # Review Jit Security Alerts + Manage review assignment for high and medium risk Jit security alerts.
@@ -40,3 +41,4 @@ Manage review assignment for high and medium risk Jit security alerts.
+ diff --git a/docs/automations/integrations/jit/review-jit-ignore-accept/README.md b/docs/automations/integrations/jit/review-jit-ignore-accept/README.md index de227844d..ae2e9c376 100644 --- a/docs/automations/integrations/jit/review-jit-ignore-accept/README.md +++ b/docs/automations/integrations/jit/review-jit-ignore-accept/README.md @@ -4,6 +4,7 @@ description: Automatically notify your security team when someone ignores Jit vu category: [security, jit] --- # Review Jit Ignore and Accept + Notify your Security team when someone ignores a Jit vulnerability report and accepts the risk.
@@ -33,3 +34,4 @@ Notify your Security team when someone ignores a Jit vulnerability report and ac
+ \ No newline at end of file diff --git a/docs/automations/integrations/jit/review-jit-secret/README.md b/docs/automations/integrations/jit/review-jit-secret/README.md index 266fc6543..07305d09d 100644 --- a/docs/automations/integrations/jit/review-jit-secret/README.md +++ b/docs/automations/integrations/jit/review-jit-secret/README.md @@ -4,6 +4,7 @@ description: Automatically block PRs that contain secrets. category: [security, jit] --- # Review Jit Secret Detection + Close PRs where Jit detects a secret and post a comment explaining steps to remedy the situation.
@@ -32,3 +33,4 @@ Close PRs where Jit detects a secret and post a comment explaining steps to reme
+ diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md index 1214a73d1..1fe66b2ca 100644 --- a/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md +++ b/docs/automations/integrations/jsdoc/review-jsdoc-input/README.md @@ -4,7 +4,7 @@ description: Automatically flag PRs that may require JSDoc updates. category: [docs, javascript] --- # Review JSDoc Input Parameters - + Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content. @@ -34,3 +34,4 @@ Warn PR authors when they change JavaScript function or constructor input parame + diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md index 096c88c32..1e90ab0ac 100644 --- a/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md +++ b/docs/automations/integrations/jsdoc/review-jsdoc-large/README.md @@ -4,7 +4,7 @@ description: Automatically flag large PRs that may require JSDoc updates. category: [docs, javascript] --- # Review JSDoc for Large Changes - + Require more extensive reviews for large JavaScript changes that lack JSDoc updates.
@@ -35,3 +35,4 @@ Require more extensive reviews for large JavaScript changes that lack JSDoc upda
+ diff --git a/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md b/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md index 583968c6e..226f312f8 100644 --- a/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md +++ b/docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md @@ -4,7 +4,7 @@ description: Enforce JSDoc requirements for PRs. category: [docs, javascript] --- # Enforce JSDoc for New JavaScript Classes - + Require JSDoc for all new JavaScript classes. @@ -36,3 +36,4 @@ Require JSDoc for all new JavaScript classes. + diff --git a/docs/automations/integrations/jsdoc/review-jsdoc/README.md b/docs/automations/integrations/jsdoc/review-jsdoc/README.md index 9ad89e947..a0bf22e55 100644 --- a/docs/automations/integrations/jsdoc/review-jsdoc/README.md +++ b/docs/automations/integrations/jsdoc/review-jsdoc/README.md @@ -4,7 +4,7 @@ description: Automatically approve PRs for JSDoc changes. category: [docs, javascript] --- # Review JSDoc Changes - + Approve PRs that only contain changes to JSDoc and assign optional reviewers.
@@ -35,3 +35,4 @@ Approve PRs that only contain changes to JSDoc and assign optional reviewers.
+ diff --git a/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md b/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md index 4602be67a..56f0778a6 100644 --- a/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md +++ b/docs/automations/integrations/sonar/approve-sonar-clean-code/README.md @@ -4,6 +4,7 @@ description: Automatically approve PRs that pass SonarCloud's quality gate. category: [security, sonarcloud] --- # Approve Sonar Clean Code + Approve PRs that pass SonarCloud's quality gate. @@ -34,3 +35,5 @@ Approve PRs that pass SonarCloud's quality gate. + + diff --git a/docs/automations/integrations/sonar/label-sonar/README.md b/docs/automations/integrations/sonar/label-sonar/README.md index 8c1b8b832..9d8112e4d 100644 --- a/docs/automations/integrations/sonar/label-sonar/README.md +++ b/docs/automations/integrations/sonar/label-sonar/README.md @@ -4,6 +4,8 @@ description: Automatically label PRs with SonarCloud insights. category: [security, sonarcloud] --- # Label SonarCloud Quality Reports + + Label the number of bugs, vulnerabilities, security hotspots, and code smells reported by SonarCloud.
@@ -30,3 +32,5 @@ Label the number of bugs, vulnerabilities, security hotspots, and code smells re
+ + diff --git a/docs/automations/integrations/sonar/review-sonar-duplications/README.md b/docs/automations/integrations/sonar/review-sonar-duplications/README.md index d408d36f6..85e9c5b00 100644 --- a/docs/automations/integrations/sonar/review-sonar-duplications/README.md +++ b/docs/automations/integrations/sonar/review-sonar-duplications/README.md @@ -4,6 +4,7 @@ description: Automatically request changes when SonarCloud detects duplicated co category: [security, sonarcloud] --- # Review Sonar Duplications + Request changes when Sonar reports an excessive level of duplicated code. @@ -32,3 +33,5 @@ Request changes when Sonar reports an excessive level of duplicated code. + + diff --git a/docs/automations/integrations/terraform/review-new-module/README.md b/docs/automations/integrations/terraform/review-new-module/README.md index 59a8a419d..a87797299 100644 --- a/docs/automations/integrations/terraform/review-new-module/README.md +++ b/docs/automations/integrations/terraform/review-new-module/README.md @@ -6,6 +6,7 @@ quickstart: false --- # Review New Terraform Modules + Request changes if a PR that creates a new Terraform module which do not conform to the required directory structure.
@@ -37,3 +38,4 @@ Request changes if a PR that creates a new Terraform module which do not conform
+ diff --git a/docs/automations/integrations/terraform/review-terraform-module-name/README.md b/docs/automations/integrations/terraform/review-terraform-module-name/README.md index 70ce1090e..5c37ed0b0 100644 --- a/docs/automations/integrations/terraform/review-terraform-module-name/README.md +++ b/docs/automations/integrations/terraform/review-terraform-module-name/README.md @@ -6,6 +6,7 @@ quickstart: false --- # Review Terraform Module Name + Request changes if a PR creates a new Terraform module that is missing a required prefix or keyword in the name.
@@ -35,3 +36,4 @@ Request changes if a PR creates a new Terraform module that is missing a require
+ diff --git a/docs/automations/integrations/terraform/review-terraform-source-version/README.md b/docs/automations/integrations/terraform/review-terraform-source-version/README.md index dd25b33e2..674354310 100644 --- a/docs/automations/integrations/terraform/review-terraform-source-version/README.md +++ b/docs/automations/integrations/terraform/review-terraform-source-version/README.md @@ -6,6 +6,7 @@ quickstart: false --- # Review Terraform Source Version + Ensure that all Terraform modules imported via a source URL specify a version.
@@ -35,3 +36,4 @@ Ensure that all Terraform modules imported via a source URL specify a version.
+ diff --git a/docs/automations/integrations/terraform/review-terraform/README.md b/docs/automations/integrations/terraform/review-terraform/README.md index e16c1d179..134961ef7 100644 --- a/docs/automations/integrations/terraform/review-terraform/README.md +++ b/docs/automations/integrations/terraform/review-terraform/README.md @@ -6,6 +6,7 @@ quickstart: false --- # Require Reviewers for Terraform changes + Automatically assign `org/infrastructure` team for reviewing changes when PR contains Terraform file changes.
@@ -34,3 +35,4 @@ Automatically assign `org/infrastructure` team for reviewing changes when PR con
+ diff --git a/docs/integrations/LB_AI.md b/docs/integrations/LB_AI.md index 19864b403..0441c4b8a 100644 --- a/docs/integrations/LB_AI.md +++ b/docs/integrations/LB_AI.md @@ -7,15 +7,16 @@ category: [quality, genai, copilot, tests, efficiency] -## Add PR Description Using LinearB's AI :material-star-circle: +## Automation Examples + +### Add PR Description Using LinearB's AI :material-star-circle: --8<-- "docs/automations/integrations/LinearBAI/describe-pr/README.md:example" -## Use LinearB's AI for a comprehensive Code Review :material-star-circle: +### Use LinearB's AI for a comprehensive Code Review :material-star-circle: --8<-- "docs/automations/integrations/LinearBAI/code-review/README.md:example" - ## Additional Resources --8<-- "docs/snippets/general.md" diff --git a/docs/integrations/askAI.md b/docs/integrations/askAI.md index b8ebebca4..08459cd3f 100644 --- a/docs/integrations/askAI.md +++ b/docs/integrations/askAI.md @@ -11,27 +11,29 @@ category: [quality, genai, copilot, tests, efficiency] [Learn more about gitStream plugins](/plugins/). -## Ask AI to Summarize the Changes in a PR +## Automation Examples + +### Ask AI to Summarize the Changes in a PR --8<-- "docs/automations/integrations/askAI/summarize-pr/README.md:example" -## Ask AI to Suggest Tests +### Ask AI to Suggest Tests --8<-- "docs/automations/integrations/askAI/add-tests/README.md:example" -## Ask AI for a Code Review +### Ask AI for a Code Review --8<-- "docs/automations/integrations/askAI/code-review/README.md:example" -## Ask AI for Documentation +### Ask AI for Documentation --8<-- "docs/automations/integrations/askAI/document/README.md:example" -## Ask AI for Code Improvements +### Ask AI for Code Improvements --8<-- "docs/automations/integrations/askAI/improve/README.md:example" - diff --git a/docs/integrations/claude-code.md b/docs/integrations/claude-code.md index 400986baa..b34ed9ac0 100644 --- a/docs/integrations/claude-code.md +++ b/docs/integrations/claude-code.md @@ -4,7 +4,9 @@ description: Workflow automations to improve your Claude Code AI usage. --- # Integrate gitStream with Claude Code -## Automatically Label Claude Code-Assisted PRs +## Automation Examples + +### Automatically Label Claude Code-Assisted PRs --8<-- "docs/automations/integrations/claude-code/flag-claude-code-pr/README.md:example" @@ -12,4 +14,4 @@ description: Workflow automations to improve your Claude Code AI usage. --8<-- "docs/snippets/general.md" ---8<-- "docs/snippets/automation-footer.md" +--8<-- "docs/snippets/automation-footer.md" \ No newline at end of file diff --git a/docs/integrations/cursor.md b/docs/integrations/cursor.md index 03962951a..a0be31132 100644 --- a/docs/integrations/cursor.md +++ b/docs/integrations/cursor.md @@ -4,7 +4,9 @@ description: Workflow automations to improve your Cursor AI usage. --- # Integrate gitStream with Cursor -## Automatically Label Cursor-Assisted PRs +## Automation Examples + +### Automatically Label Cursor-Assisted PRs --8<-- "docs/automations/integrations/cursor/flag-cursor-pr/README.md:example" @@ -12,4 +14,4 @@ description: Workflow automations to improve your Cursor AI usage. --8<-- "docs/snippets/general.md" ---8<-- "docs/snippets/automation-footer.md" +--8<-- "docs/snippets/automation-footer.md" \ No newline at end of file diff --git a/docs/integrations/github-copilot.md b/docs/integrations/github-copilot.md index 3eebfdf11..fb9e0cc3c 100644 --- a/docs/integrations/github-copilot.md +++ b/docs/integrations/github-copilot.md @@ -4,15 +4,14 @@ description: Workflow automations to improve your GitHub Copilot usage. --- # Integrate gitStream with GitHub Copilot +## Automation Examples -## Automatically Label Copilot-Assisted PRs +### Automatically Label Copilot-Assisted PRs --8<-- "docs/automations/integrations/copilot/flag-copilot-pr/README.md:example" - ## Additional Resources --8<-- "docs/snippets/general.md" ---8<-- "docs/snippets/automation-footer.md" - +--8<-- "docs/snippets/automation-footer.md" \ No newline at end of file diff --git a/docs/integrations/godoc.md b/docs/integrations/godoc.md index f8193c6d4..e823e58c6 100644 --- a/docs/integrations/godoc.md +++ b/docs/integrations/godoc.md @@ -4,13 +4,18 @@ description: Workflow automations for Godoc code reviews. --- # Integrate gitStream with Godoc -## Review Godoc Changes +## Automation Examples + +### Review Godoc Changes + --8<-- "docs/automations/integrations/godoc/review-godoc/README.md:example" -## Enforce Godoc Requirements for New Classes +### Enforce Godoc Requirements for New Classes + --8<-- "docs/automations/integrations/godoc/review-godoc-new-class/README.md:example" -## Review Godoc for Large changes +### Review Godoc for Large changes + --8<-- "docs/automations/integrations/godoc/review-godoc-large/README.md:example" ## Additional Resources @@ -19,5 +24,4 @@ description: Workflow automations for Godoc code reviews. --8<-- "docs/snippets/automation-footer.md" - -Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. +Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. \ No newline at end of file diff --git a/docs/integrations/javadoc.md b/docs/integrations/javadoc.md index 80607a634..e8d29e685 100644 --- a/docs/integrations/javadoc.md +++ b/docs/integrations/javadoc.md @@ -4,27 +4,28 @@ description: Implement workflow automations for Javadoc code reviews. --- # Integrate gitStream with Javadoc -Javadoc Examples: +## Automation Examples -* [Review Javadoc Changes](#review-javadoc) -* [Review Java Input Parameters for Javadoc Changes](#review-javadoc-input-parameters) -* [Review Javadoc for Large Changes](#review-javadoc-large-change) -* [Enforce Javadoc Requirements for New Classes](#review-new-class-javadoc) +### Review Javadoc Changes - -## Review Javadoc Changes ---8<-- "docs/automations/integrations/javadoc/review-javadoc/README.md:6:" +--8<-- "docs/automations/integrations/javadoc/review-javadoc/README.md:example" - -## Review Java Input Parameters for Javadoc Changes ---8<-- "docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md:6:" +### Review Java Input Parameters for Javadoc Changes - -## Review Javadoc for Large Changes ---8<-- "docs/automations/integrations/javadoc/review-javadoc-large-change/README.md:6:" +--8<-- "docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md:example" - -## Enforce Javadoc Requirements for New Classes ---8<-- "docs/automations/integrations/javadoc/review-new-class-javadoc/README.md:6:" +### Review Javadoc for Large Changes -Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. \ No newline at end of file +--8<-- "docs/automations/integrations/javadoc/review-javadoc-large-change/README.md:example" + +### Enforce Javadoc Requirements for New Classes + +--8<-- "docs/automations/integrations/javadoc/review-new-class-javadoc/README.md:example" + +## Additional Resources + +--8<-- "docs/snippets/general.md" + +--8<-- "docs/snippets/automation-footer.md" + +Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. diff --git a/docs/integrations/jit.md b/docs/integrations/jit.md index 0511aa062..6b521a168 100644 --- a/docs/integrations/jit.md +++ b/docs/integrations/jit.md @@ -7,25 +7,26 @@ description: Implement workflow automations for Jit security reviews. !!! Success "Included with gitStream Core Functionality" This integration is part of gitStream core functionality, and requires no additional configuration. -Jit Examples: +## Automation Examples -* [Review Jit Alerts](#review-jit-alerts) -* [Review Jit Secret Detections](#review-jit-secret) -* [Label Jit Alerts](#label-jit-alerts) -* [Review Jit Ignore and Accept Risk](#review-jit-ignore-accept) +### Review Jit Security Alerts - -## Review Jit Security Alerts ---8<-- "docs/automations/integrations/jit/review-jit-alerts/README.md:6:" +--8<-- "docs/automations/integrations/jit/review-jit-alerts/README.md:example" - -## Review Jit Secret Detection ---8<-- "docs/automations/integrations/jit/review-jit-secret/README.md:6:" +### Review Jit Secret Detection - -## Label Jit Alerts ---8<-- "docs/automations/integrations/jit/label-jit-alerts/README.md:6:" +--8<-- "docs/automations/integrations/jit/review-jit-secret/README.md:example" - -## Review Jit Ignore and Accept ---8<-- "docs/automations/integrations/jit/review-jit-ignore-accept/README.md:6:" +### Label Jit Alerts + +--8<-- "docs/automations/integrations/jit/label-jit-alerts/README.md:example" + +### Review Jit Ignore and Accept + +--8<-- "docs/automations/integrations/jit/review-jit-ignore-accept/README.md:example" + +## Additional Resources + +--8<-- "docs/snippets/general.md" + +--8<-- "docs/snippets/automation-footer.md" \ No newline at end of file diff --git a/docs/integrations/jsdoc.md b/docs/integrations/jsdoc.md index aa95e61d9..ef207b7ac 100644 --- a/docs/integrations/jsdoc.md +++ b/docs/integrations/jsdoc.md @@ -4,28 +4,28 @@ description: Implement workflow automations for JSDoc code reviews. --- # Integrate gitStream with JSDoc -JSDoc Examples: +## Automation Examples -* [Review JSDoc Changes](#review-jsdoc) -* [Review JavaScript Input Parameters for JSDoc Changes](#review-jsdoc-input-parameters) -* [Review JSDoc for Large Changes](#review-jsdoc-large-change) -* [Enforce JSDoc Requirements for New Classes](#review-new-class-jsdoc) +### Review JSDoc Changes +--8<-- "docs/automations/integrations/jsdoc/review-jsdoc/README.md:example" - -## Review JSDoc Changes ---8<-- "docs/automations/integrations/jsdoc/review-jsdoc/README.md:6:" +### Review JSDoc Input Parameters - -## Review JSDoc Input Parameters ---8<-- "docs/automations/integrations/jsdoc/review-jsdoc-input/README.md:6:" +--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-input/README.md:example" - -## Review JSDoc for Large Changes ---8<-- "docs/automations/integrations/jsdoc/review-jsdoc-large/README.md:6:" +### Review JSDoc for Large Changes - -## Enforce JSDoc for New JavaScript Classes ---8<-- "docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md:6:" +--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-large/README.md:example" -Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for help with these examples. +### Enforce JSDoc for New JavaScript Classes + +--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md:example" + +## Additional Resources + +--8<-- "docs/snippets/general.md" + +--8<-- "docs/snippets/automation-footer.md" + +Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for help with these examples. \ No newline at end of file diff --git a/docs/integrations/rdoc.md b/docs/integrations/rdoc.md index 9505e78eb..ab60a7e45 100644 --- a/docs/integrations/rdoc.md +++ b/docs/integrations/rdoc.md @@ -5,16 +5,22 @@ description: Workflow automations for RDoc code reviews. # Integrate gitStream with RDoc Integrate gitStream with [RDoc](https://github.com/ruby/rdoc): a documentation generation framework for Ruby. -## Review RDoc Changes +## Automation Examples + +### Review RDoc Changes + --8<-- "docs/automations/integrations/rdoc/review-rdoc/README.md:example" -## Enforce RDoc Requirements for New Classes +### Enforce RDoc Requirements for New Classes + --8<-- "docs/automations/integrations/rdoc/review-rdoc-new-class/README.md:example" -## Review RDoc for Large changes +### Review RDoc for Large changes + --8<-- "docs/automations/integrations/rdoc/review-rdoc-large/README.md:example" -## Review RDoc For Function Parameter Changes +### Review RDoc For Function Parameter Changes + --8<-- "docs/automations/integrations/rdoc/review-rdoc-input/README.md:example" ## Additional Resources @@ -24,4 +30,4 @@ Integrate gitStream with [RDoc](https://github.com/ruby/rdoc): a documentation g --8<-- "docs/snippets/automation-footer.md" -Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. +Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples. \ No newline at end of file diff --git a/docs/integrations/sonar.md b/docs/integrations/sonar.md index 3ed2fe5cd..4b876f78f 100644 --- a/docs/integrations/sonar.md +++ b/docs/integrations/sonar.md @@ -7,25 +7,26 @@ description: Implement workflow automations for SonarCloud security reviews. !!! Success "Included with gitStream Core Functionality" This integration is part of gitStream core functionality, and requires no additional configuration. -SonarCloud Examples: +## Automation Examples -* [Approve Sonar Clean Code](#approve-sonar-clean-code) -* [Label SonarCloud Quality Reports](#label-sonar) -* [Review Sonar Duplications](#review-sonar-duplications) -* [Review Sonar Security Alerts](#review-sonar-alerts) +### Approve Sonar Clean Code - -## Approve Sonar Clean Code ---8<-- "docs/automations/integrations/sonar/approve-sonar-clean-code/README.md:6:" +--8<-- "docs/automations/integrations/sonar/approve-sonar-clean-code/README.md:examples" - -## Label SonarCloud Quality Reports ---8<-- "docs/automations/integrations/sonar/label-sonar/README.md:6:" +### Label SonarCloud Quality Reports - -## Review Sonar Duplications ---8<-- "docs/automations/integrations/sonar/review-sonar-duplications/README.md:6:" +--8<-- "docs/automations/integrations/sonar/label-sonar/README.md:examples" - -## Review Sonar Security Alerts ---8<-- "docs/automations/integrations/sonar/review-sonar-alerts/README.md:6:" +### Review Sonar Duplications + +--8<-- "docs/automations/integrations/sonar/review-sonar-duplications/README.md:examples" + +### Review Sonar Security Alerts + +--8<-- "docs/automations/integrations/sonar/review-sonar-alerts/README.md:examples" + +## Additional Resources + +--8<-- "docs/snippets/general.md" + +--8<-- "docs/snippets/automation-footer.md" diff --git a/docs/integrations/terraform.md b/docs/integrations/terraform.md index f32a41484..02ba70e48 100644 --- a/docs/integrations/terraform.md +++ b/docs/integrations/terraform.md @@ -3,28 +3,23 @@ title: Integrate gitStream with Terraform description: Workflow automation for Terraform code reviews. --- # Integrate gitStream with Terraform -Terraform Examples: -* [Assign Reviewers for Terraform Changes](#review-terraform) +## Automation Examples -* [Review New Terraform Module](#review-new-module) +### Review Terraform Changes +--8<-- "docs/automations/integrations/terraform/review-terraform/README.md:example" -* [Review Terraform Source Version](#review-terraform-source-version) +### Enforce Requirements for New Terraform Modules +--8<-- "docs/automations/integrations/terraform/review-new-module/README.md:example" -* [Review Terraform Module Name](#review-terraform-module-name) +### Ensure Terraform Source URLs have version numbers +--8<-- "docs/automations/integrations/terraform/review-terraform-source-version/README.md:example" - -## Review Terraform Changes ---8<-- "docs/automations/integrations/terraform/review-terraform/README.md:2:" +### Ensure New Terraform Modules conform to a Naming Pattern +--8<-- "docs/automations/integrations/terraform/review-terraform-module-name/README.md:example" - -## Enforce Requirements for New Terraform Modules ---8<-- "docs/automations/integrations/terraform/review-new-module/README.md:2:" +## Additional Resources - -## Ensure Terraform Source URLs have version numbers ---8<-- "docs/automations/integrations/terraform/review-terraform-source-version/README.md:2:" +--8<-- "docs/snippets/general.md" - -## Ensure New Terraform Modules conform to a Naming Pattern ---8<-- "docs/automations/integrations/terraform/review-terraform-module-name/README.md:2:" +--8<-- "docs/snippets/automation-footer.md" \ No newline at end of file