Skip to content

Commit

Permalink
📖 mark codeApproved and sastToolRunsOnAllCommits as experimental (#4242)
Browse files Browse the repository at this point in the history
The motivation behind the probes won't change, but I want to reserve
the ability to change the probe to return 1 finding per changeset. We've
received feedback that being able to see which individual change passes or
doesn't pass is helpful.

Signed-off-by: Spencer Schrock <sschrock@google.com>
  • Loading branch information
spencerschrock committed Jul 15, 2024
1 parent b48bdbf commit bc30d0f
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/probes.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Returns OutcomeNotAvailable if Scorecard cannot fetch the data from the reposito

## codeApproved

**Lifecycle**: stable
**Lifecycle**: experimental

**Description**: Check that all recent changesets have been approved by someone who is not the author of the changeset.

Expand Down Expand Up @@ -549,7 +549,7 @@ If the project does not use a SAST tool, or uses a tool we dont currently detect

## sastToolRunsOnAllCommits

**Lifecycle**: stable
**Lifecycle**: experimental

**Description**: Checks that a SAST tool runs on all commits in the projects CI.

Expand Down
2 changes: 1 addition & 1 deletion probes/codeApproved/def.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


id: codeApproved
lifecycle: stable
lifecycle: experimental
short: Check that all recent changesets have been approved by someone who is not the author of the changeset.
motivation: >
To ensure that the review process works, the proposed changes
Expand Down
2 changes: 1 addition & 1 deletion probes/sastToolRunsOnAllCommits/def.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

id: sastToolRunsOnAllCommits
lifecycle: stable
lifecycle: experimental
short: Checks that a SAST tool runs on all commits in the projects CI.
motivation: >
SAST is testing run on source code before the application is run. Using SAST tools can prevent known classes of bugs from being inadvertently introduced in the codebase.
Expand Down

0 comments on commit bc30d0f

Please sign in to comment.