mirror of
https://github.com/ossf/scorecard.git
synced 2024-10-06 05:37:42 +03:00
2169bc44c7
Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com> Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
36 lines
1.1 KiB
Go
36 lines
1.1 KiB
Go
// Copyright 2021 OpenSSF Scorecard Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package checks contains documentation about checks.
|
|
package checks
|
|
|
|
// Doc defines the documentation interface.
|
|
type Doc interface {
|
|
GetCheck(name string) (CheckDoc, error)
|
|
GetChecks() []CheckDoc
|
|
CheckExists(name string) bool
|
|
}
|
|
|
|
// CheckDoc defines the documentation interface for a check.
|
|
type CheckDoc interface {
|
|
GetName() string
|
|
GetRisk() string
|
|
GetShort() string
|
|
GetDescription() string
|
|
GetRemediation() []string
|
|
GetTags() []string
|
|
GetSupportedRepoTypes() []string
|
|
GetDocumentationURL(commitish string) string
|
|
}
|