Skip to content

Commit

Permalink
feat: React migration - Quality PR detail page, Quality commit detail…
Browse files Browse the repository at this point in the history
… page - ALA-643 ALA-739 (#1975)

* wip: Add TODOs

* wip: Add screenshots

* feat: Quality overview section

* feat: Draft initial sections

* feat: Tweaks

* wip: Add TODOs

* fix: Broken fragment links

* feat: Fix link IDs

* clean: Remove extra tag

* feat: Conditionally hide the toggle documentation

* wip: Screenshot placeholder

* feat: Wording tweaks

* feat: Extend updates to the Commits page

* feat: Tweaks to match UI

* wip: Add TODOs

* feat: Tweaks for readability

* feat: Screenshots

* feat: Copy tweaks

* clean: Remove TODOs

* feat: Update screenshots

* feat: Tweaks for readability

* feat: Tweak screenshots

* clean: Remove gl/bb integration issues

* feat: Second-order screenshot tweaks

* feat: Tweaks

* feat: Tweaks

* feat: Apply suggestions from code review

Co-authored-by: Cláudia Carpinteiro <[email protected]>

* feat: Reorder gate status components

* feat: Update screenshots

* feat: Apply suggestion from review

Co-authored-by: Cláudia Carpinteiro <[email protected]>

* feat: Fix diff tab description

* clean: Remove TODO

* clean: Remove duplication logs screenshot

* feat: Update new/fixed issues count

* feat: Update line endings screenshot

* clean: Remove TODO

* feat: Update admonition

* feat: Apply suggestions from review

* feat: Apply review suggestions

* clean: Remove conditional display of Coverage tabs

* feat: Clarify types of complexity increase

* feat: Add placeholder commit coverage tab

* feat: Tweak wording for accuracy

* feat: Update commit coverage tab screenshot

---------

Co-authored-by: Cláudia Carpinteiro <[email protected]>
  • Loading branch information
nicklem and claudiacarpinteiro authored Apr 15, 2024
1 parent f932ac6 commit 51669f9
Show file tree
Hide file tree
Showing 39 changed files with 89 additions and 75 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Codacy calculates complexity as follows:

- The complexity value for each file is the highest cyclomatic complexity of the methods in the file.
- A file is considered complex if its cyclomatic complexity value is higher than the threshold [**File is complex when over**](../../repositories-configure/adjusting-quality-goals.md).
- The complexity value of a commit or pull request is the sum of the cyclomatic complexity of the files that were changed in the commit or pull request and that have complexity higher than 4.
- The complexity value of a commit or pull request is the sum of the cyclomatic complexity of the files that were changed in the commit or pull request and that have a high complexity increase, defined as an increase of 4 or more.

Codacy displays complexity on the following places:

Expand Down
4 changes: 2 additions & 2 deletions docs/faq/repositories/how-do-i-reanalyze-my-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To reanalyze a branch in your repository:

![Selecting the last commit on a branch](images/reanalyze-repository-commits-list.png)

1. Click the icon next to the **Current status** of the commit to trigger a reanalysis. Codacy will display a message when the analysis is complete.
1. Click the **Reanalyze** link to trigger a reanalysis. Codacy will display the status of the reanalysis request.

![Reanalyzing a commit](images/reanalyze-repository-commit.png)

Expand All @@ -38,7 +38,7 @@ To reanalyze a pull request in your repository:

![Selecting a pull request](images/reanalyze-repository-prs-list.png)

1. Click the icon next to the **Current status** of the pull request to trigger a reanalysis. Codacy will display a message when the analysis is complete.
1. Click the **Reanalyze** button to trigger a reanalysis. Codacy will display the status of the reanalysis request.

![Reanalyzing a pull request](images/reanalyze-repository-pr.png)

Expand Down
Binary file modified docs/faq/repositories/images/reanalyze-repository-commit.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/faq/repositories/images/reanalyze-repository-pr.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/faq/troubleshooting/images/duplication-commits.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 removed docs/faq/troubleshooting/images/duplication-logs.png
Binary file not shown.
Binary file modified docs/faq/troubleshooting/images/error-line-endings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@ When this happens, Codacy doesn't display code duplication metrics for the affec

![Duplication in the Files page](images/duplication-files.png)

- The **Commits** and **Pull Request** pages display an empty **New Duplication** tab.
- The **Commits** and **Pull Request** pages display an empty **Duplication** tab.

![New duplication for a commit](images/duplication-commits.png)

- The analysis logs for commits won't display a duplication analysis task for the tool corresponding to the affected language.

![Analysis logs for a commit](images/duplication-logs.png)

As a workaround, if you're exceeding the maximum number of source code files:

1. Use a [Codacy configuration file](../../repositories-configure/codacy-configuration-file.md) to exclude source code files of the affected language from your project to decrease the number of files to be analyzed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ description: Enable the Bitbucket integration to have pull request status, comme

The Bitbucket integration incorporates Codacy on your existing Git provider workflows by reporting issues and the analysis status directly on your pull requests.

When this integration is enabled, you can also create pull request comments directly from Codacy when browsing the existing repository issues on the [commit issue tabs](../../repositories/commits.md#issues-tabs) or on the [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs):

![Bitbucket integration for issues](images/bitbucket-integration-issues.png)

## Enabling the Bitbucket integration {: id="enabling"}

To enable the Bitbucket integration, open your repository **Settings**, tab **Integrations**. When you add a new repository, Codacy enables the integration using the [default settings for your organization](../../organizations/integrations/default-git-provider-integration-settings.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ description: Enable the GitHub integration to have status checks, annotations, i

The GitHub integration incorporates Codacy on your existing Git provider workflows by reporting issues and the analysis status directly on your pull requests.

When this integration is enabled, you can also create pull request comments directly from Codacy when browsing the existing repository issues on the [commit issue tabs](../../repositories/commits.md#issues-tabs) or on the [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs) of a repository:

![GitHub integration for issues](images/github-integration-issues.png)

## Enabling the GitHub integration {: id="enabling"}

To enable the GitHub integration, open your repository **Settings**, tab **Integrations**. When you add a new repository, Codacy enables the integration using the [default settings for your organization](../../organizations/integrations/default-git-provider-integration-settings.md).
Expand Down
Binary file not shown.
Binary file not shown.
10 changes: 9 additions & 1 deletion docs/repositories-coverage/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,13 @@ This area displays the coverage gate status and an overview of the coverage metr
<!--coverage-overview-end-->

<!--tab-diff-start-->
{% if page.meta.product == "coverage" %}
## Diff tab
{% else %}
## Coverage tab
{% endif %}

The **Diff** tab displays a line-by-line view of the coverage variation introduced by the {{ page.meta.page_name }}. It includes the following areas:
The {% if page.meta.product == "coverage" %}**Diff**{% else %}**Coverage**{% endif %} tab displays a line-by-line view of the coverage variation introduced by the {{ page.meta.page_name }}. It includes the following areas:

- A **list of files** modified by the {{ page.meta.page_name }}, with additional information for each file:

Expand All @@ -82,7 +86,11 @@ The **Diff** tab displays a line-by-line view of the coverage variation introduc
- **No background**: Non-coverable line

<!-- vale off -->
{% if page.meta.product == "coverage" %}
![Diff tab](images/{{ page.meta.file_name }}-tab-diff.png)
{% else %}
![Coverage tab](images/{{ page.meta.file_name }}-tab-coverage.png)
{% endif %}
<!-- vale on -->
<!--tab-diff-end-->

Expand Down
Loading

0 comments on commit 51669f9

Please sign in to comment.