-
Notifications
You must be signed in to change notification settings - Fork 63
/
options.go
64 lines (53 loc) · 1.65 KB
/
options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
// Copyright 2022 OpenSSF 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.
//
// SPDX-License-Identifier: Apache-2.0
// Package options provides installation options for the scorecard action.
package options
import (
"errors"
"path/filepath"
)
const (
configDir = "starter-workflows/code-scanning"
configFilename = "scorecards.yml"
)
var errOwnerNotSpecified = errors.New("owner not specified")
// Options are installation options for the scorecard action.
type Options struct {
// Scorecard GitHub Action configuration path
ConfigPath string
// GitHub org/repo owner
Owner string
// Repositories
Repositories []string
}
// New creates a new instance of installation options.
func New() *Options {
opts := &Options{}
opts.ConfigPath = GetConfigPath()
return opts
}
// Validate checks if the installation options specified are valid.
func (o *Options) Validate() error {
if o.Owner == "" {
return errOwnerNotSpecified
}
return nil
}
// GetConfigPath returns the local path for the scorecard action config file.
// TODO: Consider making this configurable.
func GetConfigPath() string {
return filepath.Join(configDir, configFilename)
}