From 541e4410061824cfb4fbd86dd1e9aa292aab2e1b Mon Sep 17 00:00:00 2001 From: Rohan Gupta Date: Sun, 1 Feb 2026 22:26:22 -0800 Subject: [PATCH 1/2] docs: Address Harness AI documentation gaps for MQ DevSecOps Platforms 2026 Close documentation gaps identified during MQ inclusion criteria analysis: - Undraft and expand PR Summaries page with code review assistance docs - Add IACM pipeline creation and multi-module pipeline support to DevOps Agent - Add API spec generation capability to Code Agent docs - Expand overview feature table from 12 to 23 entries covering all AI capabilities - Add IACM and multi-module example prompts to Create with AI page - Remove outdated "Infrastructure Definition Creation" from unsupported list Co-Authored-By: Claude Opus 4.5 --- docs/platform/harness-aida/ai-devops.md | 44 +++++++++++++- docs/platform/harness-aida/aida-code-pr.md | 52 +++++++++++++++-- docs/platform/harness-aida/aida-overview.md | 35 +++++++---- docs/platform/harness-aida/code-agent.md | 31 ++++++++++ .../harness-aida/harness-create-with-ai.md | 58 ++++++++++++++++++- 5 files changed, 198 insertions(+), 22 deletions(-) diff --git a/docs/platform/harness-aida/ai-devops.md b/docs/platform/harness-aida/ai-devops.md index 324cc79a6ea..c13964a37d3 100644 --- a/docs/platform/harness-aida/ai-devops.md +++ b/docs/platform/harness-aida/ai-devops.md @@ -40,8 +40,12 @@ Once authenticated, you can leverage the agent’s capabilities to manage your D |----------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | **Step Management** | Create, edit, and organize individual steps within your pipelines. | | **Stage Configuration** | Modify and configure your stages. | -| **Pipeline Orchestration** | Build and update your pipelines. | +| **Pipeline Orchestration** | Build and update your pipelines across all Harness modules. | +| **Multi-Module Pipeline Creation** | Create pipelines for CI, CD, IACM, IDP, SCS, STO, DB DevOps, and Chaos Engineering modules. | +| **Resource Creation** | Create and update Services, Environments, Connectors, and Secrets through conversational prompts. | | **Policy Generation and Integration** | Generate and integrate Open Policy Agent (OPA) Rego policies to meet your compliance standards. | +| **Error Analyzer** | AI-powered root cause analysis for pipeline failures with automated fix recommendations. | +| **Pipeline Summarizer** | Generate natural language summaries of pipelines, executions, and dependent resources. | ### Step Management @@ -68,10 +72,46 @@ Manage your complete pipelines with features including: #### Pipeline Generation Demo -For a demo of the Harness DevOps Agent generating pipelines, see the following: +For a demo of the Harness DevOps Agent generating pipelines, see the following: +### Multi-Module Pipeline Creation + +The Harness AI DevOps Agent supports creating pipelines and stages across all Harness modules, enabling teams to build end-to-end workflows that span the entire software delivery lifecycle. + +**Supported modules and stage types:** + +| **Module** | **Description** | +|------------|-----------------| +| **CI (Continuous Integration)** | Build, test, and scan stages for continuous integration workflows. | +| **CD (Continuous Delivery)** | Deployment stages with rollout strategies, approvals, and environment targeting. | +| **IACM (Infrastructure as Code Management)** | Infrastructure provisioning pipelines using Terraform and other IaC tools. | +| **IDP (Internal Developer Portal)** | Pipelines for developer self-service workflows and automation. | +| **SCS (Software Supply Chain Security)** | Supply chain security scanning and attestation stages. | +| **STO (Security Testing Orchestration)** | Security testing stages including SAST, DAST, and SCA scans. | +| **DB DevOps** | Database schema migration and change management stages. | +| **Chaos Engineering** | Chaos experiment stages for resilience testing. | +| **Custom** | Custom stages and steps for specialized workflows. | + +#### IACM Pipeline Creation + +The DevOps Agent can create Infrastructure as Code Management (IACM) pipelines that provision and manage infrastructure using Terraform and other IaC tools. This enables teams to automate infrastructure provisioning directly through conversational prompts. + +**Example prompts:** + +- "Create an IACM Pipeline that provisions AWS Infrastructure with the IACM Steps." +- "Build a pipeline with an IACM stage to manage my Terraform workspace." +- "Create a pipeline that runs Terraform plan and apply for my cloud infrastructure." + +#### Cross-Module Pipeline Examples + +You can combine stages from multiple modules in a single pipeline: + +- "Create a pipeline with a CI stage to build my app, an STO stage to scan for vulnerabilities, and a CD stage to deploy to production." +- "Build a pipeline with a Chaos Engineering stage after deployment to validate resilience." +- "Create a pipeline with an IDP workflow stage to provision a new environment, then deploy my service to it." + ### Policy Generation and Integration The Harness AI DevOps Agent also enhances compliance by generating and integrating policies. This capability allows you to: diff --git a/docs/platform/harness-aida/aida-code-pr.md b/docs/platform/harness-aida/aida-code-pr.md index a04966c0b2f..aa0527c3073 100644 --- a/docs/platform/harness-aida/aida-code-pr.md +++ b/docs/platform/harness-aida/aida-code-pr.md @@ -1,11 +1,51 @@ --- -title: Generate PR summaries with Harness AI -description: Create PR summaries with Harness AI. -sidebar_label: PR Summaries +title: AI-Powered PR Summaries and Code Review +description: Use Harness AI to generate PR summaries, analyze code changes, and facilitate code review. +sidebar_label: PR Summaries & Code Review sidebar_position: 51 -draft: true --- -import AidaPr from '/docs/code-repository/pull-requests/aida-code-pr.md'; +# AI-Powered PR Summaries and Code Review - +Harness AI enhances the code review process by automatically generating pull request summaries and providing intelligent analysis of code changes. These capabilities help teams review code faster, maintain quality, and improve collaboration. + +## PR Summary Generation + +Harness AI automatically generates comprehensive and informative summaries for pull requests by analyzing the code changes in the PR. This eliminates the need for developers to manually write detailed PR descriptions. + +When you create or update a pull request, Harness AI analyzes the diff and generates a summary that includes: + +- **Purpose of the changes** — A clear description of what the PR accomplishes and why the changes were made. +- **Issues addressed** — Identification of bugs, feature requests, or technical debt the PR resolves. +- **Potential impacts** — Analysis of how the changes may affect the existing codebase, including dependencies and downstream effects. +- **File-level change summaries** — A breakdown of what changed in each file, making it easy for reviewers to navigate large PRs. + +### Generate a PR Summary + +1. Create or open a pull request in Harness Code Repository. +2. Select **Generate Summary** (powered by Harness AI). +3. Review the AI-generated description that appears in the PR description field. +4. Edit the summary if needed, then save. + +### Benefits + +- **Faster reviews** — Reviewers can quickly understand the intent and scope of changes without reading every line of code. +- **Consistent documentation** — Every PR gets a well-structured description, improving traceability and audit trails. +- **Better communication** — Clear summaries reduce back-and-forth between authors and reviewers. +- **Improved code quality** — By promoting better understanding of changes, teams catch issues earlier in the review process. + +## Code Review Assistance + +Harness AI facilitates code review by providing intelligent analysis of code changes within pull requests. Reviewers can leverage AI to understand complex changes, identify potential issues, and make informed decisions. + +Key code review capabilities include: + +- **Code change analysis** — AI analyzes the semantic meaning of code changes, not just the diff, to explain what changed and why it matters. +- **File change summaries** — For each modified file, AI generates a concise summary of what was changed and its purpose. +- **Impact assessment** — AI identifies potential side effects, breaking changes, or areas that may need additional testing. + +These capabilities map directly into your development workflow, helping teams maintain high code quality while accelerating the review process. + +## Enable PR Summaries + +To use AI-powered PR summaries, [enable Harness AI](/docs/platform/harness-aida/aida-overview) in your account settings. PR summary generation is available for all repositories managed in Harness Code Repository. diff --git a/docs/platform/harness-aida/aida-overview.md b/docs/platform/harness-aida/aida-overview.md index 749fa174f4e..6b807701b2f 100644 --- a/docs/platform/harness-aida/aida-overview.md +++ b/docs/platform/harness-aida/aida-overview.md @@ -33,18 +33,29 @@ For more information about navigation 2.0, go to [Harness navigation 2.0](https: | Module | Feature | Description | Availability | |---|---|---|---| -| Platform | Harness Support | Harness AI can answer questions and suggest relevant documentation to help you browse and discover Harness features and documentation. | Generally available | -| Platform | Harness Support | Harness AI provides content recommendations when you create a support ticket. | Generally available | -| Platform | [Dashboard Intelligence](/docs/platform/dashboards/use-dashboard-intelligence-by-aida) | Harness AI empowers you to craft customized dashboards with widget-level control through interactive prompts. | Generally available | -| Platform | [Code Generation](/docs/platform/harness-aida/code-agent) | With the Harness AI Code Agent IDE extension, you can increase productivity by generating multi-line code updates through comments in your IDE, eliminating the need to manually write common functions or look up unknown syntax. | Beta | -| CCM | [Generate governance rules](/docs/cloud-cost-management/use-ccm-cost-governance/asset-governance/recommendations#rules-generating-recommendations) | Generate rules for asset governance accompanied with detailed descriptions to optimize your cloud spend. | Generally available | -| CD | Troubleshoot CD deployments | Resolve your deployment failures with AI's root cause analysis (RCA). | Generally available | -| CD | Policy As Code Assistant | Generate and integrate Open Policy Agent (OPA) Rego policies to meet your compliance standards with the Harness AI DevOps Agent. | Generally available | -| CD | Create Resources | Harness supports creating Service, Environment, Secrets and Connectors | Generally available | -| CE | [ChaosGuard](/docs/chaos-engineering/guides/governance/governance-in-execution/) | Generate conditions for your chaos experiments with ChaosGuard. | Generally available | -| CI | [Troubleshoot CI builds](/docs/continuous-integration/troubleshoot-ci/aida) | Resolve your build failures with Harness AI DevOps Agent's RCA. | Generally available | -| FME | [AI Summarize](/docs/platform/harness-aida/release-agent#ai-summarize) | Delivers answers from Harness FME documentation and blogs while summarizing experiment and metric results on their dashboards. | Generally available | -| STO | [Security remediation](/docs/security-testing-orchestration/remediations/ai-based-remediations) | Leverage AI to quickly analyze vulnerabilities and secure applications. | Generally available | +| **Platform** | [Harness AI DevOps Agent](/docs/platform/harness-aida/ai-devops) | Agentic AI assistant that creates and manages pipelines, stages, steps, services, environments, connectors, and secrets through natural language prompts. | Generally available | +| Platform | [DevOps Agent - Error Analyzer](/docs/platform/harness-aida/ai-devops#error-analyzer) | AI-powered root cause analysis for pipeline failures with automated fix recommendations and YAML auto-repair. | Generally available | +| Platform | [DevOps Agent - Policy Generation](/docs/platform/harness-aida/ai-devops#policy-generation-and-integration) | Generate and integrate Open Policy Agent (OPA) Rego policies to meet compliance standards. | Generally available | +| Platform | [DevOps Agent - Pipeline Summarizer](/docs/platform/harness-aida/ai-devops#pipeline-summarizer) | AI-generated natural language summaries of pipelines, executions, and dependent resources. | Generally available | +| Platform | [DevOps Agent - Resource Creation](/docs/platform/harness-aida/harness-create-with-ai) | Create Services, Environments, Connectors, and Secrets through conversational AI prompts. | Generally available | +| Platform | Harness Support | Harness AI answers questions, suggests relevant documentation, and provides content recommendations when you create a support ticket. | Generally available | +| Platform | [Dashboard Intelligence](/docs/platform/dashboards/use-dashboard-intelligence-by-aida) | Craft customized dashboards with widget-level control through interactive AI prompts. | Generally available | +| Platform | [MCP Server](/docs/platform/harness-aida/harness-mcp-server) | Model Context Protocol server enabling integration with external AI tools like Cursor, Windsurf, Claude Desktop, and VS Code. | Beta | +| **Code Repository** | [PR Summaries & Code Review](/docs/platform/harness-aida/aida-code-pr) | AI-generated pull request descriptions with code change analysis, file-level summaries, and impact assessment to facilitate code review. | Generally available | +| Code Repository | [Semantic Code Search](/docs/code-repository/work-in-repos/semantic-search) | Natural language code search that understands semantic meaning across your entire codebase. | Generally available | +| **Code Agent** | [AI Code Agent](/docs/platform/harness-aida/code-agent) | IDE extension for intelligent code generation, real-time suggestions, automated test generation, contextual code explanations, and interactive chat. | Beta | +| Code Agent | [API Spec Generation](/docs/platform/harness-aida/code-agent#api-spec-generation) | Generate OpenAPI and Swagger API specifications from your codebase using AI. | Beta | +| **CI** | [Troubleshoot CI builds](/docs/continuous-integration/troubleshoot-ci/aida) | Resolve build failures with Harness AI DevOps Agent's root cause analysis. | Generally available | +| CI | Multi-Module Pipeline Creation | AI DevOps Agent creates CI, CD, IACM, IDP, SCS, STO, DB DevOps, and Chaos Engineering pipelines and stages. | Generally available | +| **CD** | Troubleshoot CD deployments | Resolve deployment failures with AI root cause analysis (RCA). | Generally available | +| **IACM** | IACM Pipeline Creation | AI DevOps Agent creates Infrastructure as Code Management pipelines for provisioning infrastructure with Terraform and other IaC tools. | Generally available | +| **CCM** | [Generate governance rules](/docs/cloud-cost-management/use-ccm-cost-governance/asset-governance/recommendations#rules-generating-recommendations) | Generate rules for asset governance with detailed descriptions to optimize cloud spend. | Generally available | +| **STO** | [Security remediation](/docs/security-testing-orchestration/remediations/ai-based-remediations) | AI-powered vulnerability analysis and remediation recommendations to secure applications. | Generally available | +| **CE** | [ChaosGuard](/docs/chaos-engineering/guides/governance/governance-in-execution/) | Generate conditions for chaos experiments with ChaosGuard. | Generally available | +| **FME** | [Release Agent](/docs/platform/harness-aida/release-agent) | AI-powered release intelligence with documentation summarization and experiment result analysis. | Generally available | +| **SEI** | [AI Productivity Insights](/docs/software-engineering-insights/propelo-sei/ai-productivity-insights/aipi-overview) | AI-powered analysis of developer productivity, AI tool adoption impact, and engineering metrics including DORA and SPACE frameworks. | Generally available | +| **AI SRE** | [AI Scribe Agent](/docs/ai-sre/ai-agent/ai-agent) | Automated incident documentation with real-time communication monitoring across Slack, Zoom, and Microsoft Teams. | Generally available | +| **AI Test** | [AI Test Copilot](/docs/ai-test-automation/test-authoring/harness-ai-copilot/natural-language-tests) | Natural language test generation with intent-driven testing, automated step decomposition, and AI assertions. | Generally available | ## Harness AI terms and data privacy information diff --git a/docs/platform/harness-aida/code-agent.md b/docs/platform/harness-aida/code-agent.md index bf9c924ed85..f95a273bfdd 100644 --- a/docs/platform/harness-aida/code-agent.md +++ b/docs/platform/harness-aida/code-agent.md @@ -89,6 +89,37 @@ Examples include: To explore all available context providers, type `@` in the **Harness extension → Open Chat** window. +## API Spec Generation + +Harness AI Code Agent can generate API specifications from your codebase, helping you create and maintain accurate API documentation. Using the chat feature or inline prompts, you can generate OpenAPI (Swagger) specifications based on your existing code. + +### Generate API Specs + +1. Open the Harness AI Code Agent chat in your IDE. +2. Reference your API code using `@File` or `@Codebase` context providers. +3. Prompt the agent to generate an API specification. For example: + - "Generate an OpenAPI spec for the API endpoints in this file." + - "Create a Swagger specification based on my REST API routes." + - "Document all API endpoints in this project as an OpenAPI 3.0 spec." +4. Review the generated specification and save it to your project. + +### Capabilities + +- **Endpoint discovery** — Analyzes your codebase to identify API routes, methods, and parameters. +- **Schema generation** — Creates request/response schemas based on your data models and types. +- **Documentation extraction** — Pulls descriptions from code comments, docstrings, and type annotations. +- **Format support** — Generates specifications in OpenAPI 3.0 (YAML or JSON) and Swagger 2.0 formats. + +### Example + +Using the chat feature with the `@Codebase` context provider: + +```text +@Codebase Generate an OpenAPI 3.0 specification for all REST endpoints in this project, including request/response schemas and authentication requirements. +``` + +The Code Agent analyzes your route definitions, controllers, and data models to produce a complete API specification that you can use for documentation, client generation, or API testing. + ## Troubleshooting ### Networking Issues diff --git a/docs/platform/harness-aida/harness-create-with-ai.md b/docs/platform/harness-aida/harness-create-with-ai.md index a49d27ec6d8..2e7709cd76e 100644 --- a/docs/platform/harness-aida/harness-create-with-ai.md +++ b/docs/platform/harness-aida/harness-create-with-ai.md @@ -150,6 +150,60 @@ Use case: Enables IRSA-based AWS authentication via Harness delegate. Produce an AWS connector using IRSA with role ARN and delegate selectors. ``` +### Create IACM Pipelines + +The Harness AI DevOps Agent can create Infrastructure as Code Management (IACM) pipelines for provisioning and managing infrastructure using Terraform and other IaC tools. + +#### Prompts + +Use case: Provision cloud infrastructure with Terraform via an IACM pipeline. + +```text +Create an IACM Pipeline that provisions AWS Infrastructure with the IACM Steps. +``` + +Use case: Manage a Terraform workspace through a pipeline. + +```text +Build a pipeline with an IACM stage to manage my Terraform workspace. +``` + +Use case: Terraform plan and apply workflow. + +```text +Create a pipeline that runs Terraform plan and apply for my cloud infrastructure. +``` + +### Create Multi-Module Pipelines + +Harness AI supports creating pipelines with stages from multiple Harness modules, including CI, CD, IACM, IDP, SCS, STO, DB DevOps, and Chaos Engineering. + +#### Prompts + +Use case: End-to-end pipeline with security scanning. + +```text +Create a pipeline with a CI stage to build my app, an STO stage to scan for vulnerabilities, and a CD stage to deploy to production. +``` + +Use case: Pipeline with chaos engineering validation. + +```text +Build a pipeline that deploys to staging, runs a Chaos Engineering experiment to validate resilience, then promotes to production with an approval gate. +``` + +Use case: Database migration pipeline. + +```text +Create a pipeline with a DB DevOps stage to run database migrations before deploying the application with a CD stage. +``` + +Use case: Supply chain security pipeline. + +```text +Create a pipeline with an SCS stage to generate SBOM and attestation, followed by a CD stage to deploy to production. +``` + ### Reference Pipeline Templates Templates allow you to standardize steps and stages across multiple pipelines. Harness AI can reference existing templates by name. @@ -167,13 +221,13 @@ Referencing a Pipeline Template: ```text Create a Pipeline with the Golden K8s Pipeline Template ``` -### What’s Not Supported + +### What's Not Supported ##### In DevOps Use Cases Currently, Harness AI does not support generating: -- Infrastructure Definition Creation - Template Creation and Update - GitOps Application Creation and Update From 09d45d0dbd23895f30a2c65876e0ef29a2d0425e Mon Sep 17 00:00:00 2001 From: Rohan Gupta Date: Mon, 2 Feb 2026 13:04:56 -0800 Subject: [PATCH 2/2] fix: Remove broken links to draft/unavailable pages in AI overview Semantic Code Search and AI Scribe Agent pages are not available in the build (draft or excluded), so remove the hyperlinks while keeping the feature descriptions in the overview table. Co-Authored-By: Claude Opus 4.5 --- docs/platform/harness-aida/aida-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platform/harness-aida/aida-overview.md b/docs/platform/harness-aida/aida-overview.md index 6b807701b2f..d7f798ccad9 100644 --- a/docs/platform/harness-aida/aida-overview.md +++ b/docs/platform/harness-aida/aida-overview.md @@ -42,7 +42,7 @@ For more information about navigation 2.0, go to [Harness navigation 2.0](https: | Platform | [Dashboard Intelligence](/docs/platform/dashboards/use-dashboard-intelligence-by-aida) | Craft customized dashboards with widget-level control through interactive AI prompts. | Generally available | | Platform | [MCP Server](/docs/platform/harness-aida/harness-mcp-server) | Model Context Protocol server enabling integration with external AI tools like Cursor, Windsurf, Claude Desktop, and VS Code. | Beta | | **Code Repository** | [PR Summaries & Code Review](/docs/platform/harness-aida/aida-code-pr) | AI-generated pull request descriptions with code change analysis, file-level summaries, and impact assessment to facilitate code review. | Generally available | -| Code Repository | [Semantic Code Search](/docs/code-repository/work-in-repos/semantic-search) | Natural language code search that understands semantic meaning across your entire codebase. | Generally available | +| Code Repository | Semantic Code Search | Natural language code search that understands semantic meaning across your entire codebase. | Generally available | | **Code Agent** | [AI Code Agent](/docs/platform/harness-aida/code-agent) | IDE extension for intelligent code generation, real-time suggestions, automated test generation, contextual code explanations, and interactive chat. | Beta | | Code Agent | [API Spec Generation](/docs/platform/harness-aida/code-agent#api-spec-generation) | Generate OpenAPI and Swagger API specifications from your codebase using AI. | Beta | | **CI** | [Troubleshoot CI builds](/docs/continuous-integration/troubleshoot-ci/aida) | Resolve build failures with Harness AI DevOps Agent's root cause analysis. | Generally available | @@ -54,7 +54,7 @@ For more information about navigation 2.0, go to [Harness navigation 2.0](https: | **CE** | [ChaosGuard](/docs/chaos-engineering/guides/governance/governance-in-execution/) | Generate conditions for chaos experiments with ChaosGuard. | Generally available | | **FME** | [Release Agent](/docs/platform/harness-aida/release-agent) | AI-powered release intelligence with documentation summarization and experiment result analysis. | Generally available | | **SEI** | [AI Productivity Insights](/docs/software-engineering-insights/propelo-sei/ai-productivity-insights/aipi-overview) | AI-powered analysis of developer productivity, AI tool adoption impact, and engineering metrics including DORA and SPACE frameworks. | Generally available | -| **AI SRE** | [AI Scribe Agent](/docs/ai-sre/ai-agent/ai-agent) | Automated incident documentation with real-time communication monitoring across Slack, Zoom, and Microsoft Teams. | Generally available | +| **AI SRE** | AI Scribe Agent | Automated incident documentation with real-time communication monitoring across Slack, Zoom, and Microsoft Teams. | Generally available | | **AI Test** | [AI Test Copilot](/docs/ai-test-automation/test-authoring/harness-ai-copilot/natural-language-tests) | Natural language test generation with intent-driven testing, automated step decomposition, and AI assertions. | Generally available | ## Harness AI terms and data privacy information