diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index ce2a4b2e2c..d945d5e845 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -79,6 +79,32 @@ Adds AI-enhanced comments, providing insights and ready-to-commit AI-generated f ![AI-enhanced comment on GitHub](images/github-integration-ai-comment.png) +### Automatic summaries + +Even when not written by developers, Codacy can provide an high-level summary for each pull request. +Codacy generates an overview of the changes in the pull request so that any reviewer can understand it's intent and impact. + +![Automatic Summary on GitHub](images/github-integration-automatic-summary.png) + +!!! note + - This feature is only available for GitHub. + - This feature uses AWS Bedrock within Codacy's existing infrastructure. No information is shared with any other third party or used to train AI models. + - Summaries are generated using the pull request title, branch name, commit messages, and changes diff. + +Enabling this feature requires a [Codacy configuration file](../codacy-configuration-file.md). +Create a file named `codacy.yaml` in the root of your repository with the following content: + +```yaml +reviews: + high_level_summary: true +``` + +You can also enable this feature across your organization by creating the above file in the root of a repository named `.codacy`. (This file will be used as the default configuration for all repositories in the organization, and overriden by the repository-specific configuration file.) + +Once enabled, summaries will be created when pull requests are opened and kept up-to-date to reflect any changes to the pull request. + +Pull requests opened by Bot account (such as Dependabot) are automatically ignored. + ## See also - [Integrating Codacy with your Git workflow](../../getting-started/integrating-codacy-with-your-git-workflow.md) diff --git a/docs/repositories-configure/integrations/images/github-integration-automatic-summary.png b/docs/repositories-configure/integrations/images/github-integration-automatic-summary.png new file mode 100644 index 0000000000..85bc42eb64 Binary files /dev/null and b/docs/repositories-configure/integrations/images/github-integration-automatic-summary.png differ