ossf/scorecard
1
1
Fork 0
mirror of https://github.com/ossf/scorecard.git synced 2024-09-11 17:07:53 +03:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

docs: maintainer annotations (#4235)
Some checks failed
CodeQL / Analyze (go) (push) Waiting to run
Details
CodeQL / Analyze (javascript) (push) Waiting to run
Details
gitlab-tests / gitlab-integration-trusted (push) Waiting to run
Details
golangci-lint / check-linter (push) Waiting to run
Details
build / unit-test (push) Waiting to run
Details
build / generate-mocks (push) Waiting to run
Details
build / generate-docs (push) Waiting to run
Details
build / build-proto (push) Waiting to run
Details
build / ${{ matrix.target }} (build-add-script) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-bq-transfer) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-cii-worker) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-controller) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-github-server) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-scorecard) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-shuffler) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-validate-script) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-webhook) (push) Blocked by required conditions
Details
build / ${{ matrix.target }} (build-worker) (push) Blocked by required conditions
Details
build / validate-docs (push) Waiting to run
Details
build / add-projects (push) Waiting to run
Details
build / validate-projects (push) Waiting to run
Details
build / license boilerplate check (push) Waiting to run
Details
Scorecard analysis workflow / Scorecard analysis (push) Has been cancelled
Details

Browse Source 
Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>
This commit is contained in:
Raghav Kaul 2024-07-11 16:04:37 -04:00 committed by GitHub
parent c75c63c291
commit 75639713f5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -419,12 +419,11 @@ RESULTS
|---------|------------------------|--------------------------------|--------------------------------|---------------------------------------------------------------------------|
```
##### Showing Maintainers Annotations (Experimental)
##### Showing Maintainers Annotations
To see the maintainers annotations for each check, use the `--show-annotations` option.
For more information on how to configure annotations or what are the available annotations, see [the configuration doc](config/README.md).
**Maintainer Annotations** let maintainers add context to display alongside Scorecard check results. Annotations can provide users additional information when Scorecard has an incomplete assessment of a project's security practices. To see the maintainers annotations for each check, use the `--show-annotations` option.
For more information on available annotations or how to make annotations, see [the configuration doc](config/README.md).
##### Using a GitLab Repository

2
config/README.md
View File

@ -1,6 +1,6 @@
# Maintainer Annotations
**Maintainer Annotations** are an experimental feature that let maintainers add context to Scorecard check results. Annotations can inform users when Scorecard is incorrectly assessing a project's security practices.
**Maintainer Annotations** let maintainers add context to display alongside Scorecard check results. Annotations can provide users additional information when Scorecard has an incomplete assessment of a project's security practices.
## Annotating Your Project