Skip to content

Commit

Permalink
feat: React migration - Issue list CY-6604 (#1836)
Browse files Browse the repository at this point in the history
* wip: Temporary screenshots

* feat: Add TODOs and initial edits

* feat: Update GH, BB, Jira integrations

* feat: Update screenshots

* feat: Rename menu

* feat: Update references to sunset features

* feat: Tweaks

* feat: Apply code review suggestions

* feat: Apply suggestions from code review

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

* clean: Remove redundant marker

* feat: Apply code review

* feat: Update screenshots

---------

Co-authored-by: Cláudia Carpinteiro <[email protected]>
  • Loading branch information
nicklem and claudiacarpinteiro authored Oct 18, 2023
1 parent a410ef3 commit 673df81
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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 the integration is enabled, you can also create pull request comments and Jira issues directly from Codacy when [browsing the existing issues](../../repositories/issues.md) on the repository:
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), [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs), or the [Security monitor](../../repositories/security-monitor.md):

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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 the integration is enabled, you can also create pull request comments and GitHub issues directly from Codacy when [browsing the existing issues](../../repositories/issues.md) on the repository:
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), [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs), or the [Security monitor](../../repositories/security-monitor.md) of a repository:

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

Expand Down
2 changes: 2 additions & 0 deletions docs/repositories-configure/integrations/jira-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Repository Jira integration

!!! info "This feature will be removed soon and is no longer actively supported. Please avoid using it on new projects."

The Jira integration incorporates Codacy on your existing Jira workflows.

When the integration is enabled, you can create issues on a Jira project directly from Codacy when browsing the existing issues on the repository:
Expand Down
11 changes: 6 additions & 5 deletions docs/repositories/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@ This area displays the quality gate status and an overview of the code quality m

The **New Issues** and **Fixed Issues** tabs display the list of issues that the commit created or fixed.

{%
include-markdown "./issues.md"
start="<!--issue-detail-start-->"
end="<!--issue-detail-end-->"
%}
Click the title of an issue to see the following information:

- The committer and date of the commit that introduced the issue
- The [tool that reported the issue](../getting-started/supported-languages-and-tools.md) and the estimated time to fix it
- What's the issue and how to solve it
- The programming language and category of the issue

Use the options in the cogwheel menu of each issue to [ignore and manage issues](issues.md#ignoring-and-managing-issues).

Expand Down
Binary file modified docs/repositories/images/issues-detail.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/repositories/images/issues-filter.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/repositories/images/issues-menu.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/repositories/images/issues-unignore.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/repositories/images/issues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 23 additions & 26 deletions docs/repositories/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,33 @@ By default, the page lists the issues on the main branch of your repository but
!!! note
[You can use the Codacy API](../codacy-api/examples/obtaining-current-issues-in-repositories.md) to generate reports or obtain information about the current issues in your repositories in a more flexible way.

![Issues page](images/issues.png)
![Issues page](images/issues.png)<!-- TODO CY-6604 Update screenshot -->

<!--issue-detail-start-->
Click the title of an issue to see the following information:

- The committer and date of the commit that introduced the issue
- The [tool that reported the issue](../getting-started/supported-languages-and-tools.md) and the estimated time to fix it
- What's the issue and how to solve it
- The programming language and category of the issue
<!--issue-detail-end-->
- The committer and date of the commit that introduced the issue, if available
- The estimated time to fix the issue
- What the issue is and how to solve it
- The [tool that reported the issue](../getting-started/supported-languages-and-tools.md) and the related code pattern

![Issue details](images/issues-detail.png)
![Issue details](images/issues-detail.png)<!-- TODO CY-6604 Update screenshot -->

## Filtering issues

Filter the list of issues to find specific issues, such as the issues with the highest severity or security issues:

![Filtering issues](images/issues-filter.png)
![Filtering issues](images/issues-filter.png)<!-- TODO CY-6604 Update screenshot -->

You can define one or more of the following filters:

- **Language:** Programming language of the file where the issues were detected

- **Severity level:** Potential impact of the issues:

- **Critical (red):** The most dangerous issues that you should prioritize fixing since they identify code that's susceptible to serious problems regarding security and compatibility
- **Medium (yellow):** You should check out these issues, as they're based on coding standards and conventions
- **Minor (blue):** The least critical issues, such as most code style issues

- **Issue category:** One of the following types of issue:

{%
Expand All @@ -38,12 +42,6 @@ You can define one or more of the following filters:
end="<!--issue-categories-end-->"
%}

- **Severity level:** Potential impact of the issues:

- **Critical (red):** The most dangerous issues that you should prioritize fixing since they identify code that's susceptible to serious problems regarding security and compatibility
- **Medium (yellow):** You should check out these issues, as they're based on coding standards and conventions
- **Minor (blue):** The least critical issues, such as most code style issues

- **Pattern:** [Code pattern](../repositories-configure/configuring-code-patterns.md) that detected the issue

- **Author:** Commit author that introduced the issue on the code
Expand All @@ -53,7 +51,9 @@ You can define one or more of the following filters:

## Ignoring and managing issues

Use the options in the cogwheel menu of each issue to:
Use the options in the menu of each issue to:

- **Copy the link** to the issue.

- **Ignore the issue** and hide it from the list.

Expand All @@ -74,26 +74,23 @@ Use the options in the cogwheel menu of each issue to:

!!! note
- If you're using a [custom configuration file](../repositories-configure/configuring-code-patterns.md#using-your-own-tool-configuration-files), you must manage patterns manually on your configuration file.
- If your repository is following an [organization coding standard](../organizations/using-coding-standards.md), disabling the code pattern causes the repository to stop following the coding standard. In this case Codacy asks for your confirmation before accepting the changes, and then copies the coding standard configurations to your repository so you can customize them.
- If your repository is following an [organization coding standard](../organizations/using-coding-standards.md), disabling the code pattern causes the repository to stop following the coding standard. In this case, Codacy asks for your confirmation before accepting the changes and then copies the coding standard configurations to your repository, so you can customize them.

- **View the file** where the issue was detected.

- **Ignore the file** where the issue was detected.

Codacy will no longer analyze that file on your repository, so be sure that you're no longer interested in identifying any type of issues on that file. To remove an ignored file use the [Ignored Files tab](../repositories-configure/ignoring-files.md) in your repository settings.

![Issue shortcuts menu](images/issues-menu.png)

The menu can include more options depending on the features that you enable on your GitHub or Bitbucket integration:

- [GitHub integration](../repositories-configure/integrations/github-integration.md)
- [Bitbucket integration](../repositories-configure/integrations/bitbucket-integration.md)
![Issue shortcuts menu](images/issues-menu.png)<!-- TODO CY-6604 Update screenshot -->

## Restoring ignored issues

To see the list of ignored issues, click **Current Issues** and select **Ignored Issues**.
To see the list of ignored issues, click the **Ignored** tab.

To restore an ignored issue, click the button **Unignore** next to the issue title:
To restore an ignored issue, click the issue title to expand the details and select **Unignore issue** from the options menu:

![Restoring an ignored issue](images/issues-unignore.png)
![Restoring an ignored issue](images/issues-unignore.png)<!-- TODO CY-6604 Update screenshot -->

## See also

Expand Down

0 comments on commit 673df81

Please sign in to comment.