From b87aadc2c3d73d1e425e47b930468f93d98c11d6 Mon Sep 17 00:00:00 2001 From: Eryn Muetzel <137318000+eryn-muetzel@users.noreply.github.com> Date: Mon, 6 Nov 2023 10:08:02 -0800 Subject: [PATCH] Update activity.md Updated title to reflect that Trusty score will be more than activity over time; updated copy to reflect user can set threshold. Consider changing the option in the code from `pi_threshold` to "trusty_threshold' (and then update this doc) - but not urgent. --- docs/docs/ref/rules/activity.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docs/ref/rules/activity.md b/docs/docs/ref/rules/activity.md index e479780797..8e8f66c1e1 100644 --- a/docs/docs/ref/rules/activity.md +++ b/docs/docs/ref/rules/activity.md @@ -1,18 +1,18 @@ --- -title: Activity Score +title: Trusty Score sidebar_position: 20 --- -# Activity Score Threshold Rule +# Trusty Score Threshold Rule -The following rule type is available for [Trusty](https://www.trustypkg.dev/) activity score threshold. +The following rule type is available for [Trusty](https://www.trustypkg.dev/) score threshold. -## `pr_trusty_check` - Verifies that pull requests do not add any dependencies with low Trusty scores +## `pr_trusty_check` - Verifies that pull requests do not add any dependencies with Trusty scores below a certain threshold -This rule allows you to monitor new Pull requests for newly added dependencies with low +This rule allows you to monitor new pull requests for newly added dependencies with low [Trusty](https://www.trustypkg.dev/) scores. For every pull request submitted to a repository, this rule will check if the pull request adds a new dependency with -a low Trusty score. If a dependency with a low score is added, the PR will be commented on. +a Trusty score below a threshold that you define. If a dependency with a low score is added, the PR will be commented on. ## Entity - `pull_request`