Skip to content

Commit

Permalink
Merge branch 'master' into fix/update-supported-languages
Browse files Browse the repository at this point in the history
  • Loading branch information
mrfyda authored Jun 4, 2024
2 parents d8fc862 + 51dde61 commit 84f1226
Show file tree
Hide file tree
Showing 23 changed files with 84 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,9 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \

You can also upload all your reports dynamically using the command `find`. For example:

!!! note
This example works only on systems that use GNU `find` with support for the `-printf` action, such as Linux.

```bash
bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
-l Java $(find . -name 'jacoco*.xml' -printf '-r %p ')
-l Java $(find . -name 'jacoco*.xml' | sed 's,^, -r ,' | xargs echo)
```

### Uploading reports in sequence {: id="multiple-reports-sequence"}
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/supported-languages-and-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The table below lists all languages that Codacy supports and the corresponding t
<td>-</td>
<td><a href="https://trivy.dev">Trivy</a></td>
<td>-</td>
<td>-</td>
<td><a href="https://github.com/kucherenko/jscpd">jscpd</a></td>
<td>-</td>
</tr>
<tr>
Expand Down
Binary file modified docs/organizations/images/coding-standard-apply.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-configure-tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-rename.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/coding-standard-select-languages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/repositories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/organizations/images/security-risk-management-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/organizations/managing-security-and-risk.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ For a detailed view of the distribution on a specific week, hover over the graph

The **Activity history** graph shows weekly counts of open and closed findings over the past three months, overlaid on the overall open findings trend. It complements the **Open findings history** graph with more information, such as the volume of findings addressed each week and a visual representation of the new/closed ratio.

To filter the graph by finding severity, use the drop-down in the top right-hand corner of the panel.

For a detailed view of the counts on a specific week, hover over the graph.

![Security and risk management activity history panel](images/security-risk-management-overview-history-activity.png)
Expand Down
85 changes: 57 additions & 28 deletions docs/organizations/using-coding-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Coding standards enable the analysis of multiple repositories with the same tool
This page covers the following topics:

- [Creating a coding standard](#creating)
- [Configuring a coding standard using advanced settings](#advanced-settings)
- [Defining a default coding standard](#set-default)
- [Editing a coding standard](#editing)
- [Deleting a coding standard](#deleting)
Expand All @@ -21,31 +22,65 @@ To create a coding standard for your organization:

1. Click the button **Create new standard** at the top right-hand corner of the page. This opens the coding standard creation form.

1. Enter a unique name and click **Create standard**.
1. Enter a unique name for the new coding standard.

Optionally, select a repository to use as a baseline for the new coding standard. This is useful if you already have a well-configured repository that you wish to use as a template.
Optionally, you can:

- Select a repository to use as a baseline for the new coding standard. This is useful if you already have a well-configured repository that you wish to use as a template.
- Set the new coding standard as your organization's [default coding standard](#set-default), so it applies automatically to new repositories.

![Creating a new coding standard](images/coding-standard-create.png)

1. Select the programming languages that the new coding standard should cover.
1. Click **Create coding standard**.

1. Adjust the sensitivity of the coding standard from **Essential** to **Comprehensive** for each issue category group:

- **Essential**: Focuses on the most important issues by including the most critical code patterns. Ideal for initial integration, to prevent overwhelming developers, and to speed up analysis times.
- **Comprehensive**: Detects all issues by including all code patterns, capturing the complete severity spectrum. Ideal for detailed code quality reviews, while reducing emphasis on critical issues. It may increase analysis times.

!!! tip
Initially, set the sensitivity to **Essential** for most category groups to focus on critical code patterns. It helps streamline the integration process with Codacy without overwhelming developers with too many reported issues. You can gradually include more patterns as needed.

If you want more control over included code patterns, click **Advanced settings** to [customize the coding standard](#advanced-settings).

![Coding standard presets](images/coding-standard-presets.png)

1. Click **Next: Select and apply to repositories**.

1. Select existing repositories that should follow the new coding standard and click **Save and apply coding standard**.

Codacy will start using the new coding standard on the next analysis of each selected repository.

!!! note
A repository can follow one coding standard at a time. Assigning a coding standard to a repository unassigns any previously assigned coding standard.

![Applying the coding standard to repositories](images/coding-standard-apply.png)

## Configuring a coding standard using advanced settings {: id="advanced-settings"}

If you need more control when [creating a new coding standard](#creating), click **Advanced settings** to more precisely define the tools and code patterns that the coding standard should use. When editing an existing coding standard, the advanced settings are the default view.

To configure a coding standard using advanced settings:

1. Select the programming languages that the new coding standard should include.

!!! important
The coding standard will only control tools that can analyze one or more of the languages selected in this step.

For the remaining languages not selected in this step, Codacy uses existing repository-level configurations if present or global Codacy defaults otherwise, potentially analyzing some of the omitted languages. To prevent this:

1. Ensure all languages are selected, so that the coding standard controls all tools.
If a language is omitted in this step, Codacy uses repository-level tool configurations if present or global Codacy defaults otherwise, and may analyze the omitted language. To prevent this:

1. In this step select all languages, so that the coding standard controls all tools.

1. In the next step, explicitly disable the tools that you don't want to use.

![Selecting the languages for the coding standard](images/coding-standard-select-languages.png)

1. Click **Next: Tools and patterns**.

1. Configure the tools and patterns of the coding standard.
1. Configure the tools and patterns of the coding standard:

- Toggle the tools to run when Codacy analyzes your code
- For each enabled tool, configure the code patterns to use
- Toggle the tools to run when Codacy analyzes your code.
- For each enabled tool, configure the code patterns to use.

!!! tip
- Use the filters to find the relevant tools and code patterns. The recommended configurations are manually curated by Codacy or based on tool defaults and are marked with the icon ![Recommended icon](images/coding-standard-recommended-icon.png).
Expand All @@ -54,16 +89,7 @@ To create a coding standard for your organization:

![Configuring the tools and patterns for the coding standard](images/coding-standard-configure-tools.png)

1. Click **Next: Select and apply to repositories**.

1. Select existing repositories that should follow the new coding standard and click **Save and apply standard**.

Codacy will start using the new coding standard on the next analysis of each selected repository.

!!! note
A repository can follow one coding standard at a time. Assigning a coding standard to a repository unassigns any previously assigned coding standard.

![Applying the coding standard to repositories](images/coding-standard-apply.png)
1. Proceed with the remaining wizard steps to finish [creating](#creating) or [editing](#editing) your coding standard.

## Defining a default coding standard {: id="set-default"}

Expand All @@ -72,14 +98,16 @@ For ease of management, you can define a default coding standard that automatica
!!! note
When Codacy introduces new tools, those are automatically added to the global Codacy defaults but need to be manually added to the default coding standard.

To set a coding standard as default:
You can set a new coding standard as default when [creating](#creating) one.

To set an existing coding standard as default:

1. Open your organization **Policies** page, tab **Coding standards**.

1. Toggle **Make default** on the relevant coding standard card.

!!! note
Only one coding standard at a time can be the default coding standard.
Only one coding standard at a time can be the default coding standard.

![Setting a coding standard as the default](images/coding-standard-set-default.png)

Expand All @@ -96,17 +124,18 @@ To edit an existing coding standard or change the repositories that follow that

![Editing an existing coding standard](images/coding-standard-edit.png)

1. Edit the current coding standard configurations and click the button **Next** to advance between the following pages:
1. Edit the current coding standard configurations and click the button **Next** to advance to the following [configuration pages](#advanced-settings):

- **Select languages**: the programming languages that the coding standard applies to.

- The programming languages that the coding standard applies to
- The tool and code pattern configurations of the coding standard
- The repositories that follow the coding standard
On this page, you can rename the coding standard by clicking the edit icon next to the name of the coding standard.

You can also rename the coding standard using the input at the bottom of the first page of the wizard:
![Renaming a coding standard](images/coding-standard-rename.png)

![Renaming a coding standard](images/coding-standard-rename.png)
- **Choose tools and patterns**: the tool and code pattern configurations of the coding standard.
- **Select and apply to repositories**: the repositories that follow the coding standard.

1. Click the button **Save and apply standard** on the repository selection page to save your changes to the coding standard.
1. Click the button **Save and apply coding standard** on the repository selection page to save your changes to the coding standard.

Codacy will start using the updated coding standard on the next analysis of each selected repository.

Expand Down
4 changes: 2 additions & 2 deletions docs/repositories-configure/configuring-code-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ The table below lists the configuration file names that Codacy detects and suppo
<tr>
<td>RuboCop</td>
<td>Ruby</td>
<td><code>.rubocop.yml</code></td>
<td></td>
<td><code>.rubocop.yml</code>, <code>.rubocop-codacy.yml</code></td>
<td>Supports alternative configuration file <code>.rubocop-codacy.yml</code> for Codacy analysis, allowing exclusion of private gems. This prevents analysis issues caused by private gem references, ensuring proper validation by Codacy.</td>
</tr>
<tr>
<td>Scalastyle</td>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/repositories-coverage/images/pull-requests-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/repositories-coverage/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ This area displays detailed information about the pull request:
- Pull request author, pull request branch, target branch, and pull request identifier on the Git provider
- Last updated date of the pull request
- Link to the pull request on your Git provider
- Link to reanalyze the pull request
- Codacy logs<!--NOTE As an improvement, explain how to read the logs in more detail-->

![Pull request information](images/pull-requests-detail-information.png)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/repositories/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ To restore an ignored issue, select **Unignore issue** from the options menu:

![Restoring an ignored issue](images/issues-unignore.png)

## Fixing issues automatically

!!! info "This section applies to GitHub repositories only"

If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears above the issue list. Click this button to open a pull request including the suggested fixes and targeting the selected branch.

![Fix issues button](images/issues-fix-issues-button.png)

## See also

- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
Expand Down
8 changes: 8 additions & 0 deletions docs/repositories/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ Click a specific commit to see [detailed information about that commit](commits.

![Commits tab](images/pull-requests-tab-commits.png)

## Fixing issues automatically

!!! info "This section applies to GitHub repositories only"

If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears above the issue list. Click this button to commit the suggested fixes to the pull request.

![Fix issues button](images/issues-fix-issues-button.png)

## See also

- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
2 changes: 2 additions & 0 deletions docs/repositories/repository-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ The **Issues breakdown** area displays the total number of issues found on the s

Click **See all issues** to see the full [list of issues](issues.md) found, or click a category to see the issues in that category.

If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears below the total issue count. Click this button to open a pull request including the suggested fixes and targeting the selected branch.

![Issues breakdown](images/repository-dashboard-issues-breakdown.png)

## Coverage
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ pymdown-extensions==10.8.1
# MkDocs plugins
mkdocs-exclude-search==0.6.6
mkdocs-exclude==1.0.2
mkdocs-git-revision-date-localized-plugin==1.2.5
mkdocs-include-markdown-plugin==6.0.6
mkdocs-git-revision-date-localized-plugin==1.2.6
mkdocs-include-markdown-plugin==6.1.1
mkdocs-macros-plugin==1.0.5
mkdocs-meta-descriptions-plugin==3.0.0
mkdocs-monorepo-plugin==1.1.0
Expand Down

0 comments on commit 84f1226

Please sign in to comment.