Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Add documentation for dependency explorer TAROT-2953 #2300

Closed
wants to merge 1 commit into from
Closed

feature: Add documentation for dependency explorer TAROT-2953 #2300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/organizations/images/security-risk-management-dependencies-list.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/organizations/images/security-risk-management-dependencies-single.png
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

- [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 @@
</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
Open in desktop
Submodule chart deleted from 6b6841
1 change: 0 additions & 1 deletion submodules/codacy-mkdocs-material
Open in desktop
Submodule codacy-mkdocs-material deleted from 954b29
Loading