Skip to content

Commit

Permalink
feature: Add documentation for dependency explorer TAROT-2953
Browse files Browse the repository at this point in the history
  • Loading branch information
lventura-codacy committed Dec 23, 2024
1 parent 705f57b commit 6ec1a17
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 2 deletions.
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.
22 changes: 22 additions & 0 deletions docs/organizations/managing-security-and-risk.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Under Security and risk management, you can find the following pages to help you

- [Overview](#dashboard)
- [Findings](#item-list)
- [Dependencies](#dependencies-list)

In addition, on these pages, you can [share filtered views of findings](#sharing-filtered-view), [export findings as a CSV file](#exporting-the-security-item-list), and [review severity rules and integration settings](#reviewing-settings)

Expand Down Expand Up @@ -514,6 +515,27 @@ Security and risk management supports checking the languages and infrastructure-
</tbody>
</table>

## Dependencies {: id="dependencu-list"}

The **Security and risk management dependencies** page displays a unified view of all dependencies used by your repositories.

To access the dependencies page, access the [overview page](#dashboard) and click the **Findings** tab.

![Security and risk management dependencies page](images/security-risk-management-dependencies-list.png)

When viewing dependencies, you'll be presented with a list of the dependencies used by all repositories in your organization. For each dependency you'll be able to see how many repositories are making use of it, how many different versions you are using accross all repositories, as well as how many security findings were found due to the presence of that dependency.

Check failure on line 526 in docs/organizations/managing-security-and-risk.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'accross'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'accross'?", "location": {"path": "docs/organizations/managing-security-and-risk.md", "range": {"start": {"line": 526, "column": 255}}}, "severity": "ERROR"}

You're also able to click any dependency to find out more information about it.

![Security and risk management dependency page](images/security-risk-management-dependencies-single.png)

The dependency overview page offers a quick birds-eye view of that particular dependency. You'll be able to see all different versions that are being used, including which repository is using them, the oldest and most recent versions you're leveraging, as well as the highest criticaliy of security issues and the license applied to any particular version of that dependency.

Check failure on line 532 in docs/organizations/managing-security-and-risk.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'criticaliy'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'criticaliy'?", "location": {"path": "docs/organizations/managing-security-and-risk.md", "range": {"start": {"line": 532, "column": 278}}}, "severity": "ERROR"}

!!! important
The dependency explorer is a timed business-tier feature! We'll be releasing it to every Pro user in the near future, but if in the meanwhile you want to learn about it, and other business features we're offereing or have planned [get in touch with us](https://www.codacy.com/pricing)!

Check failure on line 535 in docs/organizations/managing-security-and-risk.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'offereing'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'offereing'?", "location": {"path": "docs/organizations/managing-security-and-risk.md", "range": {"start": {"line": 535, "column": 209}}}, "severity": "ERROR"}



<sup><span id="semgrep">1</span></sup>: Semgrep supports additional security rules when signing up for [Semgrep Pro](https://semgrep.dev/pricing/).
<sup><span id="yaml-only">2</span></sup>: Currently, Trivy only supports scanning YAML files on this platform.
<sup><span id="client-side">3</span></sup>: Supported as a [client-side tool](../repositories-configure/local-analysis/client-side-tools.md).
Expand Down
1 change: 0 additions & 1 deletion submodules/chart
Submodule chart deleted from 6b6841
1 change: 0 additions & 1 deletion submodules/codacy-mkdocs-material
Submodule codacy-mkdocs-material deleted from 954b29

0 comments on commit 6ec1a17

Please sign in to comment.