Skip to content

Commit

Permalink
feat: Initial description for Automatic Summary
Browse files Browse the repository at this point in the history
  • Loading branch information
mrfyda committed May 27, 2024
1 parent c37b5bb commit 70e1384
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/repositories-configure/integrations/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.)

Check failure on line 102 in docs/repositories-configure/integrations/github-integration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'overriden'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'overriden'?", "location": {"path": "docs/repositories-configure/integrations/github-integration.md", "range": {"start": {"line": 102, "column": 230}}}, "severity": "ERROR"}

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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 70e1384

Please sign in to comment.